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