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