doc/man3/EVP_EncryptInit.pod

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