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