doc/man3/EVP_EncryptInit.pod

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