Add EVP_CIPHER_do_all_ex() and EVP_MD_do_all_ex()
[openssl.git] / doc / man3 / EVP_EncryptInit.pod
1 =pod
2
3 =head1 NAME
4
5 EVP_CIPHER_fetch,
6 EVP_CIPHER_CTX_new,
7 EVP_CIPHER_CTX_reset,
8 EVP_CIPHER_CTX_free,
9 EVP_EncryptInit_ex,
10 EVP_EncryptUpdate,
11 EVP_EncryptFinal_ex,
12 EVP_DecryptInit_ex,
13 EVP_DecryptUpdate,
14 EVP_DecryptFinal_ex,
15 EVP_CipherInit_ex,
16 EVP_CipherUpdate,
17 EVP_CipherFinal_ex,
18 EVP_CIPHER_CTX_set_key_length,
19 EVP_CIPHER_CTX_ctrl,
20 EVP_EncryptInit,
21 EVP_EncryptFinal,
22 EVP_DecryptInit,
23 EVP_DecryptFinal,
24 EVP_CipherInit,
25 EVP_CipherFinal,
26 EVP_get_cipherbyname,
27 EVP_get_cipherbynid,
28 EVP_get_cipherbyobj,
29 EVP_CIPHER_name,
30 EVP_CIPHER_provider,
31 EVP_CIPHER_nid,
32 EVP_CIPHER_block_size,
33 EVP_CIPHER_key_length,
34 EVP_CIPHER_iv_length,
35 EVP_CIPHER_flags,
36 EVP_CIPHER_mode,
37 EVP_CIPHER_type,
38 EVP_CIPHER_CTX_cipher,
39 EVP_CIPHER_CTX_name,
40 EVP_CIPHER_CTX_nid,
41 EVP_CIPHER_CTX_block_size,
42 EVP_CIPHER_CTX_key_length,
43 EVP_CIPHER_CTX_iv_length,
44 EVP_CIPHER_CTX_get_app_data,
45 EVP_CIPHER_CTX_set_app_data,
46 EVP_CIPHER_CTX_type,
47 EVP_CIPHER_CTX_flags,
48 EVP_CIPHER_CTX_mode,
49 EVP_CIPHER_param_to_asn1,
50 EVP_CIPHER_asn1_to_param,
51 EVP_CIPHER_CTX_set_padding,
52 EVP_enc_null,
53 EVP_CIPHER_do_all_ex
54 - EVP cipher routines
55
56 =head1 SYNOPSIS
57
58 =for comment generic
59
60  #include <openssl/evp.h>
61
62  EVP_CIPHER *EVP_CIPHER_fetch(OPENSSL_CTX *ctx, const char *algorithm,
63                               const char *properties);
64  EVP_CIPHER_CTX *EVP_CIPHER_CTX_new(void);
65  int EVP_CIPHER_CTX_reset(EVP_CIPHER_CTX *ctx);
66  void EVP_CIPHER_CTX_free(EVP_CIPHER_CTX *ctx);
67
68  int EVP_EncryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
69                         ENGINE *impl, const unsigned char *key, const unsigned char *iv);
70  int EVP_EncryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
71                        int *outl, const unsigned char *in, int inl);
72  int EVP_EncryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl);
73
74  int EVP_DecryptInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
75                         ENGINE *impl, const unsigned char *key, const unsigned char *iv);
76  int EVP_DecryptUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
77                        int *outl, const unsigned char *in, int inl);
78  int EVP_DecryptFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl);
79
80  int EVP_CipherInit_ex(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
81                        ENGINE *impl, const unsigned char *key, const unsigned char *iv, int enc);
82  int EVP_CipherUpdate(EVP_CIPHER_CTX *ctx, unsigned char *out,
83                       int *outl, const unsigned char *in, int inl);
84  int EVP_CipherFinal_ex(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl);
85
86  int EVP_EncryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
87                      const unsigned char *key, const unsigned char *iv);
88  int EVP_EncryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *out, int *outl);
89
90  int EVP_DecryptInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
91                      const unsigned char *key, const unsigned char *iv);
92  int EVP_DecryptFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl);
93
94  int EVP_CipherInit(EVP_CIPHER_CTX *ctx, const EVP_CIPHER *type,
95                     const unsigned char *key, const unsigned char *iv, int enc);
96  int EVP_CipherFinal(EVP_CIPHER_CTX *ctx, unsigned char *outm, int *outl);
97
98  int EVP_CIPHER_CTX_set_padding(EVP_CIPHER_CTX *x, int padding);
99  int EVP_CIPHER_CTX_set_key_length(EVP_CIPHER_CTX *x, int keylen);
100  int EVP_CIPHER_CTX_ctrl(EVP_CIPHER_CTX *ctx, int type, int arg, void *ptr);
101  int EVP_CIPHER_CTX_rand_key(EVP_CIPHER_CTX *ctx, unsigned char *key);
102
103  const EVP_CIPHER *EVP_get_cipherbyname(const char *name);
104  const EVP_CIPHER *EVP_get_cipherbynid(int nid);
105  const EVP_CIPHER *EVP_get_cipherbyobj(const ASN1_OBJECT *a);
106
107  int EVP_CIPHER_nid(const EVP_CIPHER *e);
108  const char *EVP_CIPHER_name(const EVP_CIPHER *cipher);
109  const OSSL_PROVIDER *EVP_CIPHER_provider(const EVP_CIPHER *cipher);
110  int EVP_CIPHER_block_size(const EVP_CIPHER *e);
111  int EVP_CIPHER_key_length(const EVP_CIPHER *e);
112  int EVP_CIPHER_iv_length(const EVP_CIPHER *e);
113  unsigned long EVP_CIPHER_flags(const EVP_CIPHER *e);
114  unsigned long EVP_CIPHER_mode(const EVP_CIPHER *e);
115  int EVP_CIPHER_type(const EVP_CIPHER *ctx);
116
117  const EVP_CIPHER *EVP_CIPHER_CTX_cipher(const EVP_CIPHER_CTX *ctx);
118  int EVP_CIPHER_CTX_nid(const EVP_CIPHER_CTX *ctx);
119  const char *EVP_CIPHER_CTX_name(const EVP_CIPHER_CTX *ctx);
120  int EVP_CIPHER_CTX_block_size(const EVP_CIPHER_CTX *ctx);
121  int EVP_CIPHER_CTX_key_length(const EVP_CIPHER_CTX *ctx);
122  int EVP_CIPHER_CTX_iv_length(const EVP_CIPHER_CTX *ctx);
123  void *EVP_CIPHER_CTX_get_app_data(const EVP_CIPHER_CTX *ctx);
124  void EVP_CIPHER_CTX_set_app_data(const EVP_CIPHER_CTX *ctx, void *data);
125  int EVP_CIPHER_CTX_type(const EVP_CIPHER_CTX *ctx);
126  int EVP_CIPHER_CTX_mode(const EVP_CIPHER_CTX *ctx);
127
128  int EVP_CIPHER_param_to_asn1(EVP_CIPHER_CTX *c, ASN1_TYPE *type);
129  int EVP_CIPHER_asn1_to_param(EVP_CIPHER_CTX *c, ASN1_TYPE *type);
130
131  void EVP_CIPHER_do_all_ex(OPENSSL_CTX *libctx,
132                            void (*fn)(EVP_CIPHER *cipher, void *arg),
133                            void *arg);
134
135 =head1 DESCRIPTION
136
137 The EVP cipher routines are a high level interface to certain
138 symmetric ciphers.
139
140 EVP_CIPHER_fetch() fetches the cipher implementation for the given
141 B<algorithm> from any provider offering it, within the criteria given
142 by the B<properties>.
143 See L<provider(7)/Fetching algorithms> for further information.
144
145 The returned value must eventually be freed with
146 L<EVP_CIPHER_meth_free(3)>.
147
148 EVP_CIPHER_CTX_new() creates a cipher context.
149
150 EVP_CIPHER_CTX_free() clears all information from a cipher context
151 and free up any allocated memory associate with it, including B<ctx>
152 itself. This function should be called after all operations using a
153 cipher are complete so sensitive information does not remain in
154 memory.
155
156 EVP_EncryptInit_ex() sets up cipher context B<ctx> for encryption
157 with cipher B<type>. B<type> is typically supplied by a function such
158 as EVP_aes_256_cbc(), or a value explicitly fetched with
159 EVP_CIPHER_fetch(). If B<impl> is non-NULL, its implementation of the
160 cipher B<type> is used if there is one, and if not, the default
161 implementation is used. B<key> is the symmetric key to use
162 and B<iv> is the IV to use (if necessary), the actual number of bytes
163 used for the key and IV depends on the cipher. It is possible to set
164 all parameters to NULL except B<type> in an initial call and supply
165 the remaining parameters in subsequent calls, all of which have B<type>
166 set to NULL. This is done when the default cipher parameters are not
167 appropriate.
168
169 EVP_EncryptUpdate() encrypts B<inl> bytes from the buffer B<in> and
170 writes the encrypted version to B<out>. This function can be called
171 multiple times to encrypt successive blocks of data. The amount
172 of data written depends on the block alignment of the encrypted data:
173 as a result the amount of data written may be anything from zero bytes
174 to (inl + cipher_block_size - 1) so B<out> should contain sufficient
175 room. The actual number of bytes written is placed in B<outl>. It also
176 checks if B<in> and B<out> are partially overlapping, and if they are
177 0 is returned to indicate failure.
178
179 If padding is enabled (the default) then EVP_EncryptFinal_ex() encrypts
180 the "final" data, that is any data that remains in a partial block.
181 It uses standard block padding (aka PKCS padding) as described in
182 the NOTES section, below. The encrypted
183 final data is written to B<out> which should have sufficient space for
184 one cipher block. The number of bytes written is placed in B<outl>. After
185 this function is called the encryption operation is finished and no further
186 calls to EVP_EncryptUpdate() should be made.
187
188 If padding is disabled then EVP_EncryptFinal_ex() will not encrypt any more
189 data and it will return an error if any data remains in a partial block:
190 that is if the total data length is not a multiple of the block size.
191
192 EVP_DecryptInit_ex(), EVP_DecryptUpdate() and EVP_DecryptFinal_ex() are the
193 corresponding decryption operations. EVP_DecryptFinal() will return an
194 error code if padding is enabled and the final block is not correctly
195 formatted. The parameters and restrictions are identical to the encryption
196 operations except that if padding is enabled the decrypted data buffer B<out>
197 passed to EVP_DecryptUpdate() should have sufficient room for
198 (B<inl> + cipher_block_size) bytes unless the cipher block size is 1 in
199 which case B<inl> bytes is sufficient.
200
201 EVP_CipherInit_ex(), EVP_CipherUpdate() and EVP_CipherFinal_ex() are
202 functions that can be used for decryption or encryption. The operation
203 performed depends on the value of the B<enc> parameter. It should be set
204 to 1 for encryption, 0 for decryption and -1 to leave the value unchanged
205 (the actual value of 'enc' being supplied in a previous call).
206
207 EVP_CIPHER_CTX_reset() clears all information from a cipher context
208 and free up any allocated memory associate with it, except the B<ctx>
209 itself. This function should be called anytime B<ctx> is to be reused
210 for another EVP_CipherInit() / EVP_CipherUpdate() / EVP_CipherFinal()
211 series of calls.
212
213 EVP_EncryptInit(), EVP_DecryptInit() and EVP_CipherInit() behave in a
214 similar way to EVP_EncryptInit_ex(), EVP_DecryptInit_ex() and
215 EVP_CipherInit_ex() except they always use the default cipher implementation.
216
217 EVP_EncryptFinal(), EVP_DecryptFinal() and EVP_CipherFinal() are
218 identical to EVP_EncryptFinal_ex(), EVP_DecryptFinal_ex() and
219 EVP_CipherFinal_ex(). In previous releases they also cleaned up
220 the B<ctx>, but this is no longer done and EVP_CIPHER_CTX_clean()
221 must be called to free any context resources.
222
223 EVP_get_cipherbyname(), EVP_get_cipherbynid() and EVP_get_cipherbyobj()
224 return an EVP_CIPHER structure when passed a cipher name, a NID or an
225 ASN1_OBJECT structure.
226
227 EVP_CIPHER_nid() and EVP_CIPHER_CTX_nid() return the NID of a cipher when
228 passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX> structure.  The actual NID
229 value is an internal value which may not have a corresponding OBJECT
230 IDENTIFIER.
231
232 EVP_CIPHER_CTX_set_padding() enables or disables padding. This
233 function should be called after the context is set up for encryption
234 or decryption with EVP_EncryptInit_ex(), EVP_DecryptInit_ex() or
235 EVP_CipherInit_ex(). By default encryption operations are padded using
236 standard block padding and the padding is checked and removed when
237 decrypting. If the B<pad> parameter is zero then no padding is
238 performed, the total amount of data encrypted or decrypted must then
239 be a multiple of the block size or an error will occur.
240
241 EVP_CIPHER_key_length() and EVP_CIPHER_CTX_key_length() return the key
242 length of a cipher when passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX>
243 structure. The constant B<EVP_MAX_KEY_LENGTH> is the maximum key length
244 for all ciphers. Note: although EVP_CIPHER_key_length() is fixed for a
245 given cipher, the value of EVP_CIPHER_CTX_key_length() may be different
246 for variable key length ciphers.
247
248 EVP_CIPHER_CTX_set_key_length() sets the key length of the cipher ctx.
249 If the cipher is a fixed length cipher then attempting to set the key
250 length to any value other than the fixed value is an error.
251
252 EVP_CIPHER_iv_length() and EVP_CIPHER_CTX_iv_length() return the IV
253 length of a cipher when passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX>.
254 It will return zero if the cipher does not use an IV.  The constant
255 B<EVP_MAX_IV_LENGTH> is the maximum IV length for all ciphers.
256
257 EVP_CIPHER_block_size() and EVP_CIPHER_CTX_block_size() return the block
258 size of a cipher when passed an B<EVP_CIPHER> or B<EVP_CIPHER_CTX>
259 structure. The constant B<EVP_MAX_BLOCK_LENGTH> is also the maximum block
260 length for all ciphers.
261
262 EVP_CIPHER_type() and EVP_CIPHER_CTX_type() return the type of the passed
263 cipher or context. This "type" is the actual NID of the cipher OBJECT
264 IDENTIFIER as such it ignores the cipher parameters and 40 bit RC2 and
265 128 bit RC2 have the same NID. If the cipher does not have an object
266 identifier or does not have ASN1 support this function will return
267 B<NID_undef>.
268
269 EVP_CIPHER_name() and EVP_CIPHER_CTX_name() return the name of the passed
270 cipher or context.
271
272 EVP_CIPHER_provider() returns an B<OSSL_PROVIDER> pointer to the provider
273 that implements the given B<EVP_CIPHER>.
274
275 EVP_CIPHER_CTX_cipher() returns the B<EVP_CIPHER> structure when passed
276 an B<EVP_CIPHER_CTX> structure.
277
278 EVP_CIPHER_mode() and EVP_CIPHER_CTX_mode() return the block cipher mode:
279 EVP_CIPH_ECB_MODE, EVP_CIPH_CBC_MODE, EVP_CIPH_CFB_MODE, EVP_CIPH_OFB_MODE,
280 EVP_CIPH_CTR_MODE, EVP_CIPH_GCM_MODE, EVP_CIPH_CCM_MODE, EVP_CIPH_XTS_MODE,
281 EVP_CIPH_WRAP_MODE or EVP_CIPH_OCB_MODE. If the cipher is a stream cipher then
282 EVP_CIPH_STREAM_CIPHER is returned.
283
284 EVP_CIPHER_param_to_asn1() sets the AlgorithmIdentifier "parameter" based
285 on the passed cipher. This will typically include any parameters and an
286 IV. The cipher IV (if any) must be set when this call is made. This call
287 should be made before the cipher is actually "used" (before any
288 EVP_EncryptUpdate(), EVP_DecryptUpdate() calls for example). This function
289 may fail if the cipher does not have any ASN1 support.
290
291 EVP_CIPHER_asn1_to_param() sets the cipher parameters based on an ASN1
292 AlgorithmIdentifier "parameter". The precise effect depends on the cipher
293 In the case of RC2, for example, it will set the IV and effective key length.
294 This function should be called after the base cipher type is set but before
295 the key is set. For example EVP_CipherInit() will be called with the IV and
296 key set to NULL, EVP_CIPHER_asn1_to_param() will be called and finally
297 EVP_CipherInit() again with all parameters except the key set to NULL. It is
298 possible for this function to fail if the cipher does not have any ASN1 support
299 or the parameters cannot be set (for example the RC2 effective key length
300 is not supported.
301
302 EVP_CIPHER_CTX_ctrl() allows various cipher specific parameters to be determined
303 and set.
304
305 EVP_CIPHER_CTX_rand_key() generates a random key of the appropriate length
306 based on the cipher context. The EVP_CIPHER can provide its own random key
307 generation routine to support keys of a specific form. B<Key> must point to a
308 buffer at least as big as the value returned by EVP_CIPHER_CTX_key_length().
309
310 EVP_CIPHER_do_all_ex() traverses all ciphers implemented by all activated
311 providers in the given library context I<libctx>, and for each of the
312 implementations, calls the given function I<fn> with the implementation method
313 and the given I<arg> as argument.
314
315 =head1 RETURN VALUES
316
317 EVP_CIPHER_fetch() returns a pointer to a B<EVP_CIPHER> for success
318 and B<NULL> for failure.
319
320 EVP_CIPHER_CTX_new() returns a pointer to a newly created
321 B<EVP_CIPHER_CTX> for success and B<NULL> for failure.
322
323 EVP_EncryptInit_ex(), EVP_EncryptUpdate() and EVP_EncryptFinal_ex()
324 return 1 for success and 0 for failure.
325
326 EVP_DecryptInit_ex() and EVP_DecryptUpdate() return 1 for success and 0 for failure.
327 EVP_DecryptFinal_ex() returns 0 if the decrypt failed or 1 for success.
328
329 EVP_CipherInit_ex() and EVP_CipherUpdate() return 1 for success and 0 for failure.
330 EVP_CipherFinal_ex() returns 0 for a decryption failure or 1 for success.
331
332 EVP_CIPHER_CTX_reset() returns 1 for success and 0 for failure.
333
334 EVP_get_cipherbyname(), EVP_get_cipherbynid() and EVP_get_cipherbyobj()
335 return an B<EVP_CIPHER> structure or NULL on error.
336
337 EVP_CIPHER_nid() and EVP_CIPHER_CTX_nid() return a NID.
338
339 EVP_CIPHER_block_size() and EVP_CIPHER_CTX_block_size() return the block
340 size.
341
342 EVP_CIPHER_key_length() and EVP_CIPHER_CTX_key_length() return the key
343 length.
344
345 EVP_CIPHER_CTX_set_padding() always returns 1.
346
347 EVP_CIPHER_iv_length() and EVP_CIPHER_CTX_iv_length() return the IV
348 length or zero if the cipher does not use an IV.
349
350 EVP_CIPHER_type() and EVP_CIPHER_CTX_type() return the NID of the cipher's
351 OBJECT IDENTIFIER or NID_undef if it has no defined OBJECT IDENTIFIER.
352
353 EVP_CIPHER_CTX_cipher() returns an B<EVP_CIPHER> structure.
354
355 EVP_CIPHER_param_to_asn1() and EVP_CIPHER_asn1_to_param() return greater
356 than zero for success and zero or a negative number on failure.
357
358 EVP_CIPHER_CTX_rand_key() returns 1 for success.
359
360 =head1 CIPHER LISTING
361
362 All algorithms have a fixed key length unless otherwise stated.
363
364 Refer to L<SEE ALSO> for the full list of ciphers available through the EVP
365 interface.
366
367 =over 4
368
369 =item EVP_enc_null()
370
371 Null cipher: does nothing.
372
373 =back
374
375 =head1 AEAD Interface
376
377 The EVP interface for Authenticated Encryption with Associated Data (AEAD)
378 modes are subtly altered and several additional I<ctrl> operations are supported
379 depending on the mode specified.
380
381 To specify additional authenticated data (AAD), a call to EVP_CipherUpdate(),
382 EVP_EncryptUpdate() or EVP_DecryptUpdate() should be made with the output
383 parameter B<out> set to B<NULL>.
384
385 When decrypting, the return value of EVP_DecryptFinal() or EVP_CipherFinal()
386 indicates whether the operation was successful. If it does not indicate success,
387 the authentication operation has failed and any output data B<MUST NOT> be used
388 as it is corrupted.
389
390 =head2 GCM and OCB Modes
391
392 The following I<ctrl>s are supported in GCM and OCB modes.
393
394 =over 4
395
396 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)
397
398 Sets the IV length. This call can only be made before specifying an IV. If
399 not called a default IV length is used.
400
401 For GCM AES and OCB AES the default is 12 (i.e. 96 bits). For OCB mode the
402 maximum is 15.
403
404 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, taglen, tag)
405
406 Writes C<taglen> bytes of the tag value to the buffer indicated by C<tag>.
407 This call can only be made when encrypting data and B<after> all data has been
408 processed (e.g. after an EVP_EncryptFinal() call).
409
410 For OCB, C<taglen> must either be 16 or the value previously set via
411 B<EVP_CTRL_AEAD_SET_TAG>.
412
413 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag)
414
415 Sets the expected tag to C<taglen> bytes from C<tag>.
416 The tag length can only be set before specifying an IV.
417 C<taglen> must be between 1 and 16 inclusive.
418
419 For GCM, this call is only valid when decrypting data.
420
421 For OCB, this call is valid when decrypting data to set the expected tag,
422 and before encryption to set the desired tag length.
423
424 In OCB mode, calling this before encryption with C<tag> set to C<NULL> sets the
425 tag length.  If this is not called prior to encryption, a default tag length is
426 used.
427
428 For OCB AES, the default tag length is 16 (i.e. 128 bits).  It is also the
429 maximum tag length for OCB.
430
431 =back
432
433 =head2 CCM Mode
434
435 The EVP interface for CCM mode is similar to that of the GCM mode but with a
436 few additional requirements and different I<ctrl> values.
437
438 For CCM mode, the total plaintext or ciphertext length B<MUST> be passed to
439 EVP_CipherUpdate(), EVP_EncryptUpdate() or EVP_DecryptUpdate() with the output
440 and input parameters (B<in> and B<out>) set to B<NULL> and the length passed in
441 the B<inl> parameter.
442
443 The following I<ctrl>s are supported in CCM mode.
444
445 =over 4
446
447 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag)
448
449 This call is made to set the expected B<CCM> tag value when decrypting or
450 the length of the tag (with the C<tag> parameter set to NULL) when encrypting.
451 The tag length is often referred to as B<M>. If not set a default value is
452 used (12 for AES). When decrypting, the tag needs to be set before passing
453 in data to be decrypted, but as in GCM and OCB mode, it can be set after
454 passing additional authenticated data (see L<AEAD Interface>).
455
456 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_CCM_SET_L, ivlen, NULL)
457
458 Sets the CCM B<L> value. If not set a default is used (8 for AES).
459
460 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)
461
462 Sets the CCM nonce (IV) length. This call can only be made before specifying an
463 nonce value. The nonce length is given by B<15 - L> so it is 7 by default for
464 AES.
465
466 =back
467
468 =head2 SIV Mode
469
470 For SIV mode ciphers the behaviour of the EVP interface is subtly
471 altered and several additional ctrl operations are supported.
472
473 To specify any additional authenticated data (AAD) and/or a Nonce, a call to
474 EVP_CipherUpdate(), EVP_EncryptUpdate() or EVP_DecryptUpdate() should be made
475 with the output parameter B<out> set to B<NULL>.
476
477 RFC5297 states that the Nonce is the last piece of AAD before the actual
478 encrypt/decrypt takes place. The API does not differentiate the Nonce from
479 other AAD.
480
481 When decrypting the return value of EVP_DecryptFinal() or EVP_CipherFinal()
482 indicates if the operation was successful. If it does not indicate success
483 the authentication operation has failed and any output data B<MUST NOT>
484 be used as it is corrupted.
485
486 The following ctrls are supported in both SIV modes.
487
488 =over 4
489
490 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, taglen, tag);
491
492 Writes B<taglen> bytes of the tag value to the buffer indicated by B<tag>.
493 This call can only be made when encrypting data and B<after> all data has been
494 processed (e.g. after an EVP_EncryptFinal() call). For SIV mode the taglen must
495 be 16.
496
497 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag);
498
499 Sets the expected tag to B<taglen> bytes from B<tag>. This call is only legal
500 when decrypting data and must be made B<before> any data is processed (e.g.
501 before any EVP_DecryptUpdate() call). For SIV mode the taglen must be 16.
502
503 =back
504
505 SIV mode makes two passes over the input data, thus, only one call to
506 EVP_CipherUpdate(), EVP_EncryptUpdate() or EVP_DecryptUpdate() should be made
507 with B<out> set to a non-B<NULL> value. A call to EVP_Decrypt_Final() or
508 EVP_CipherFinal() is not required, but will indicate if the update
509 operation succeeded.
510
511 =head2 ChaCha20-Poly1305
512
513 The following I<ctrl>s are supported for the ChaCha20-Poly1305 AEAD algorithm.
514
515 =over 4
516
517 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_IVLEN, ivlen, NULL)
518
519 Sets the nonce length. This call can only be made before specifying the nonce.
520 If not called a default nonce length of 12 (i.e. 96 bits) is used. The maximum
521 nonce length is 12 bytes (i.e. 96-bits). If a nonce of less than 12 bytes is set
522 then the nonce is automatically padded with leading 0 bytes to make it 12 bytes
523 in length.
524
525 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_GET_TAG, taglen, tag)
526
527 Writes C<taglen> bytes of the tag value to the buffer indicated by C<tag>.
528 This call can only be made when encrypting data and B<after> all data has been
529 processed (e.g. after an EVP_EncryptFinal() call).
530
531 C<taglen> specified here must be 16 (B<POLY1305_BLOCK_SIZE>, i.e. 128-bits) or
532 less.
533
534 =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_AEAD_SET_TAG, taglen, tag)
535
536 Sets the expected tag to C<taglen> bytes from C<tag>.
537 The tag length can only be set before specifying an IV.
538 C<taglen> must be between 1 and 16 (B<POLY1305_BLOCK_SIZE>) inclusive.
539 This call is only valid when decrypting data.
540
541 =back
542
543 =head1 NOTES
544
545 Where possible the B<EVP> interface to symmetric ciphers should be used in
546 preference to the low level interfaces. This is because the code then becomes
547 transparent to the cipher used and much more flexible. Additionally, the
548 B<EVP> interface will ensure the use of platform specific cryptographic
549 acceleration such as AES-NI (the low level interfaces do not provide the
550 guarantee).
551
552 PKCS padding works by adding B<n> padding bytes of value B<n> to make the total
553 length of the encrypted data a multiple of the block size. Padding is always
554 added so if the data is already a multiple of the block size B<n> will equal
555 the block size. For example if the block size is 8 and 11 bytes are to be
556 encrypted then 5 padding bytes of value 5 will be added.
557
558 When decrypting the final block is checked to see if it has the correct form.
559
560 Although the decryption operation can produce an error if padding is enabled,
561 it is not a strong test that the input data or key is correct. A random block
562 has better than 1 in 256 chance of being of the correct format and problems with
563 the input data earlier on will not produce a final decrypt error.
564
565 If padding is disabled then the decryption operation will always succeed if
566 the total amount of data decrypted is a multiple of the block size.
567
568 The functions EVP_EncryptInit(), EVP_EncryptFinal(), EVP_DecryptInit(),
569 EVP_CipherInit() and EVP_CipherFinal() are obsolete but are retained for
570 compatibility with existing code. New code should use EVP_EncryptInit_ex(),
571 EVP_EncryptFinal_ex(), EVP_DecryptInit_ex(), EVP_DecryptFinal_ex(),
572 EVP_CipherInit_ex() and EVP_CipherFinal_ex() because they can reuse an
573 existing context without allocating and freeing it up on each call.
574
575 EVP_get_cipherbynid(), and EVP_get_cipherbyobj() are implemented as macros.
576
577 =head1 BUGS
578
579 B<EVP_MAX_KEY_LENGTH> and B<EVP_MAX_IV_LENGTH> only refer to the internal
580 ciphers with default key lengths. If custom ciphers exceed these values the
581 results are unpredictable. This is because it has become standard practice to
582 define a generic key as a fixed unsigned char array containing
583 B<EVP_MAX_KEY_LENGTH> bytes.
584
585 The ASN1 code is incomplete (and sometimes inaccurate) it has only been tested
586 for certain common S/MIME ciphers (RC2, DES, triple DES) in CBC mode.
587
588 =head1 EXAMPLES
589
590 Encrypt a string using IDEA:
591
592  int do_crypt(char *outfile)
593  {
594      unsigned char outbuf[1024];
595      int outlen, tmplen;
596      /*
597       * Bogus key and IV: we'd normally set these from
598       * another source.
599       */
600      unsigned char key[] = {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15};
601      unsigned char iv[] = {1,2,3,4,5,6,7,8};
602      char intext[] = "Some Crypto Text";
603      EVP_CIPHER_CTX *ctx;
604      FILE *out;
605
606      ctx = EVP_CIPHER_CTX_new();
607      EVP_EncryptInit_ex(ctx, EVP_idea_cbc(), NULL, key, iv);
608
609      if (!EVP_EncryptUpdate(ctx, outbuf, &outlen, intext, strlen(intext))) {
610          /* Error */
611          EVP_CIPHER_CTX_free(ctx);
612          return 0;
613      }
614      /*
615       * Buffer passed to EVP_EncryptFinal() must be after data just
616       * encrypted to avoid overwriting it.
617       */
618      if (!EVP_EncryptFinal_ex(ctx, outbuf + outlen, &tmplen)) {
619          /* Error */
620          EVP_CIPHER_CTX_free(ctx);
621          return 0;
622      }
623      outlen += tmplen;
624      EVP_CIPHER_CTX_free(ctx);
625      /*
626       * Need binary mode for fopen because encrypted data is
627       * binary data. Also cannot use strlen() on it because
628       * it won't be NUL terminated and may contain embedded
629       * NULs.
630       */
631      out = fopen(outfile, "wb");
632      if (out == NULL) {
633          /* Error */
634          return 0;
635      }
636      fwrite(outbuf, 1, outlen, out);
637      fclose(out);
638      return 1;
639  }
640
641 The ciphertext from the above example can be decrypted using the B<openssl>
642 utility with the command line (shown on two lines for clarity):
643
644  openssl idea -d \
645      -K 000102030405060708090A0B0C0D0E0F -iv 0102030405060708 <filename
646
647 General encryption and decryption function example using FILE I/O and AES128
648 with a 128-bit key:
649
650  int do_crypt(FILE *in, FILE *out, int do_encrypt)
651  {
652      /* Allow enough space in output buffer for additional block */
653      unsigned char inbuf[1024], outbuf[1024 + EVP_MAX_BLOCK_LENGTH];
654      int inlen, outlen;
655      EVP_CIPHER_CTX *ctx;
656      /*
657       * Bogus key and IV: we'd normally set these from
658       * another source.
659       */
660      unsigned char key[] = "0123456789abcdeF";
661      unsigned char iv[] = "1234567887654321";
662
663      /* Don't set key or IV right away; we want to check lengths */
664      ctx = EVP_CIPHER_CTX_new();
665      EVP_CipherInit_ex(&ctx, EVP_aes_128_cbc(), NULL, NULL, NULL,
666                        do_encrypt);
667      OPENSSL_assert(EVP_CIPHER_CTX_key_length(ctx) == 16);
668      OPENSSL_assert(EVP_CIPHER_CTX_iv_length(ctx) == 16);
669
670      /* Now we can set key and IV */
671      EVP_CipherInit_ex(ctx, NULL, NULL, key, iv, do_encrypt);
672
673      for (;;) {
674          inlen = fread(inbuf, 1, 1024, in);
675          if (inlen <= 0)
676              break;
677          if (!EVP_CipherUpdate(ctx, outbuf, &outlen, inbuf, inlen)) {
678              /* Error */
679              EVP_CIPHER_CTX_free(ctx);
680              return 0;
681          }
682          fwrite(outbuf, 1, outlen, out);
683      }
684      if (!EVP_CipherFinal_ex(ctx, outbuf, &outlen)) {
685          /* Error */
686          EVP_CIPHER_CTX_free(ctx);
687          return 0;
688      }
689      fwrite(outbuf, 1, outlen, out);
690
691      EVP_CIPHER_CTX_free(ctx);
692      return 1;
693  }
694
695
696 =head1 SEE ALSO
697
698 L<evp(7)>
699
700 Supported ciphers are listed in:
701
702 L<EVP_aes(3)>,
703 L<EVP_aria(3)>,
704 L<EVP_bf(3)>,
705 L<EVP_camellia(3)>,
706 L<EVP_cast5(3)>,
707 L<EVP_chacha20(3)>,
708 L<EVP_des(3)>,
709 L<EVP_desx(3)>,
710 L<EVP_idea(3)>,
711 L<EVP_rc2(3)>,
712 L<EVP_rc4(3)>,
713 L<EVP_rc5(3)>,
714 L<EVP_seed(3)>,
715 L<EVP_sm4(3)>
716
717 =head1 HISTORY
718
719 Support for OCB mode was added in OpenSSL 1.1.0.
720
721 B<EVP_CIPHER_CTX> was made opaque in OpenSSL 1.1.0.  As a result,
722 EVP_CIPHER_CTX_reset() appeared and EVP_CIPHER_CTX_cleanup()
723 disappeared.  EVP_CIPHER_CTX_init() remains as an alias for
724 EVP_CIPHER_CTX_reset().
725
726 =head1 COPYRIGHT
727
728 Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
729
730 Licensed under the Apache License 2.0 (the "License").  You may not use
731 this file except in compliance with the License.  You can obtain a copy
732 in the file LICENSE in the source distribution or at
733 L<https://www.openssl.org/source/license.html>.
734
735 =cut