EVP_CIPHER_METH_NEW(3ossl)
π EVP_CIPHER_METH_NEW(3ossl) π
okay so bestie, welcome to the ossl corner of the manual β this one's a whole vibe, and by "vibe" I mean everything here is deprecated, but you still gotta know it because legacy code exists and she is thriving in the wild. These are the routines that build up EVP_CIPHER methods. π
β¨ NAME β¨
EVP_CIPHER_meth_new, EVP_CIPHER_meth_dup, EVP_CIPHER_meth_free, EVP_CIPHER_meth_set_iv_length, EVP_CIPHER_meth_set_flags, EVP_CIPHER_meth_set_impl_ctx_size, EVP_CIPHER_meth_set_init, EVP_CIPHER_meth_set_do_cipher, EVP_CIPHER_meth_set_cleanup, EVP_CIPHER_meth_set_set_asn1_params, EVP_CIPHER_meth_set_get_asn1_params, EVP_CIPHER_meth_set_ctrl, EVP_CIPHER_meth_get_init, EVP_CIPHER_meth_get_do_cipher, EVP_CIPHER_meth_get_cleanup, EVP_CIPHER_meth_get_set_asn1_params, EVP_CIPHER_meth_get_get_asn1_params, EVP_CIPHER_meth_get_ctrl β literally the routines to build up EVP_CIPHER methods. the whole girl squad, together at last π«Ά
πΈ SYNOPSIS πΈ
#include <openssl/evp.h>
β οΈ heads up bestie: the following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by definingOPENSSL_API_COMPATwith a suitable version value β seeopenssl_user_macros(7). so likeβ¦ yes she's iconic but she's also retired. π
EVP_CIPHER *EVP_CIPHER_meth_new(int cipher_type, int block_size, int key_len);
EVP_CIPHER *EVP_CIPHER_meth_dup(const EVP_CIPHER *cipher);
void EVP_CIPHER_meth_free(EVP_CIPHER *cipher);
int EVP_CIPHER_meth_set_iv_length(EVP_CIPHER *cipher, int iv_len);
int EVP_CIPHER_meth_set_flags(EVP_CIPHER *cipher, unsigned long flags);
int EVP_CIPHER_meth_set_impl_ctx_size(EVP_CIPHER *cipher, int ctx_size);
int EVP_CIPHER_meth_set_init(EVP_CIPHER *cipher,
int (*init)(EVP_CIPHER_CTX *ctx,
const unsigned char *key,
const unsigned char *iv,
int enc));
int EVP_CIPHER_meth_set_do_cipher(EVP_CIPHER *cipher,
int (*do_cipher)(EVP_CIPHER_CTX *ctx,
unsigned char *out,
const unsigned char *in,
size_t inl));
int EVP_CIPHER_meth_set_cleanup(EVP_CIPHER *cipher,
int (*cleanup)(EVP_CIPHER_CTX *));
int EVP_CIPHER_meth_set_set_asn1_params(EVP_CIPHER *cipher,
int (*set_asn1_parameters)(EVP_CIPHER_CTX *,
ASN1_TYPE *));
int EVP_CIPHER_meth_set_get_asn1_params(EVP_CIPHER *cipher,
int (*get_asn1_parameters)(EVP_CIPHER_CTX *,
ASN1_TYPE *));
int EVP_CIPHER_meth_set_ctrl(EVP_CIPHER *cipher,
int (*ctrl)(EVP_CIPHER_CTX *, int type,
int arg, void *ptr));
int (*EVP_CIPHER_meth_get_init(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *ctx,
const unsigned char *key,
const unsigned char *iv,
int enc);
int (*EVP_CIPHER_meth_get_do_cipher(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *ctx,
unsigned char *out,
const unsigned char *in,
size_t inl);
int (*EVP_CIPHER_meth_get_cleanup(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *);
int (*EVP_CIPHER_meth_get_set_asn1_params(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *,
ASN1_TYPE *);
int (*EVP_CIPHER_meth_get_get_asn1_params(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *,
ASN1_TYPE *);
int (*EVP_CIPHER_meth_get_ctrl(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *,
int type, int arg,
void *ptr);
π¦ DESCRIPTION π¦
okay so first thing's first, bestie β all of the functions described on this page are deprecated. not "kinda old", not "on thin ice", like officially deprecated. Applications should instead use the OSSL_PROVIDER APIs. that's the glow-up. periodt. π
The EVP_CIPHER type is a structure for symmetric cipher method implementation.
EVP_CIPHER_meth_new()β creates a newEVP_CIPHERstructure. fresh out of the box β¨EVP_CIPHER_meth_dup()β creates a copy of cipher.EVP_CIPHER_meth_free()β destroys aEVP_CIPHERstructure. If the argument isNULL, nothing is done. (no drama, no crash, we love a graceful exit π )EVP_CIPHER_meth_set_iv_length()β sets the length of the IV. This is only needed when the implemented cipher mode requires it.EVP_CIPHER_meth_set_flags()β sets the flags to describe optional behaviours in the particular cipher. With the exception of cipher modes, of which only one may be present, several flags can be or'd together. The available flags are:EVP_CIPH_STREAM_CIPHER,EVP_CIPH_ECB_MODE,EVP_CIPH_CBC_MODE,EVP_CIPH_CFB_MODE,EVP_CIPH_OFB_MODE,EVP_CIPH_CTR_MODE,EVP_CIPH_GCM_MODE,EVP_CIPH_CCM_MODE,EVP_CIPH_XTS_MODE,EVP_CIPH_WRAP_MODE,EVP_CIPH_OCB_MODE,EVP_CIPH_SIV_MODEβ The cipher mode.EVP_CIPH_VARIABLE_LENGTHβ This cipher is of variable length.EVP_CIPH_CUSTOM_IVβ Storing and initialising the IV is left entirely to the implementation.EVP_CIPH_ALWAYS_CALL_INITβ Set this if the implementation'sinit()function should be called even ifkeyisNULL.EVP_CIPH_CTRL_INITβ Set this to have the implementation'sctrl()function called with command codeEVP_CTRL_INITearly in its setup.EVP_CIPH_CUSTOM_KEY_LENGTHβ Checking and setting the key length after creating theEVP_CIPHERis left to the implementation. Whenever someone usesEVP_CIPHER_CTX_set_key_length()on aEVP_CIPHERwith this flag set, the implementation'sctrl()function will be called with the control codeEVP_CTRL_SET_KEY_LENGTHand the key length inarg.EVP_CIPH_NO_PADDINGβ Don't use standard block padding.EVP_CIPH_RAND_KEYβ Making a key with random content is left to the implementation. This is done by calling the implementation'sctrl()function with the control codeEVP_CTRL_RAND_KEYand the pointer to the key memory storage inptr.EVP_CIPH_CUSTOM_COPYβ Set this to have the implementation'sctrl()function called with command codeEVP_CTRL_COPYat the end ofEVP_CIPHER_CTX_copy(). The intended use is for further things to deal with after the implementation specific data block has been copied. The destinationEVP_CIPHER_CTXis passed to the control with theptrparameter. The implementation specific data block is reached withEVP_CIPHER_CTX_get_cipher_data().EVP_CIPH_FLAG_DEFAULT_ASN1β Use the default EVP routines to pass IV to and from ASN.1.EVP_CIPH_FLAG_LENGTH_BITSβ Signals that the length of the input buffer for encryption / decryption is to be understood as the number of bits instead of bytes for this implementation. This is only useful for CFB1 ciphers.EVP_CIPH_FLAG_CTSβ Indicates that the cipher uses ciphertext stealing. This is currently used to indicate that the cipher is a one shot that only allows a single call toEVP_CipherUpdate().EVP_CIPH_FLAG_CUSTOM_CIPHERβ This indicates that the implementation takes care of everything, including padding, buffering and finalization. The EVP routines will simply give them control and do nothing more. main character energy, honestly πEVP_CIPH_FLAG_AEAD_CIPHERβ This indicates that this is an AEAD cipher implementation.EVP_CIPH_FLAG_TLS1_1_MULTIBLOCKβ Allow interleaving of crypto blocks, a particular optimization only applicable to certain TLS ciphers.
EVP_CIPHER_meth_set_impl_ctx_size()β sets the size of theEVP_CIPHER's implementation context so that it can be automatically allocated.EVP_CIPHER_meth_set_init()β sets the cipher init function for cipher. The cipher init function is called byEVP_CipherInit(),EVP_CipherInit_ex(),EVP_EncryptInit(),EVP_EncryptInit_ex(),EVP_DecryptInit(),EVP_DecryptInit_ex().EVP_CIPHER_meth_set_do_cipher()β sets the cipher function for cipher. The cipher function is called byEVP_CipherUpdate(),EVP_EncryptUpdate(),EVP_DecryptUpdate(),EVP_CipherFinal(),EVP_EncryptFinal(),EVP_EncryptFinal_ex(),EVP_DecryptFinal()andEVP_DecryptFinal_ex().EVP_CIPHER_meth_set_cleanup()β sets the function for cipher to do extra cleanup before the method's private data structure is cleaned out and freed. Note that the cleanup function is passed aEVP_CIPHER_CTX *, the private data structure is then available withEVP_CIPHER_CTX_get_cipher_data(). This cleanup function is called byEVP_CIPHER_CTX_reset()andEVP_CIPHER_CTX_free().EVP_CIPHER_meth_set_set_asn1_params()β sets the function for cipher to set theAlgorithmIdentifier"parameter" based on the passed cipher. This function is called byEVP_CIPHER_param_to_asn1().EVP_CIPHER_meth_set_get_asn1_params()sets the function for cipher that sets the cipher parameters based on an ASN.1AlgorithmIdentifier"parameter". Both these functions are needed when there is a need for custom data (more or other than the cipher IV). They are called byEVP_CIPHER_param_to_asn1()andEVP_CIPHER_asn1_to_param()respectively if defined.EVP_CIPHER_meth_set_ctrl()β sets the control function for cipher.EVP_CIPHER_meth_get_init(),EVP_CIPHER_meth_get_do_cipher(),EVP_CIPHER_meth_get_cleanup(),EVP_CIPHER_meth_get_set_asn1_params(),EVP_CIPHER_meth_get_get_asn1_params()andEVP_CIPHER_meth_get_ctrl()β are all used to retrieve the method data given with theEVP_CIPHER_meth_set_*()functions above. the getters to the setters, the read receipts, iykyk π₯
π RETURN VALUES π
EVP_CIPHER_meth_new() and EVP_CIPHER_meth_dup() return a pointer to a newly created EVP_CIPHER, or NULL on failure. All EVP_CIPHER_meth_set_*() functions return 1. All EVP_CIPHER_meth_get_*() functions return pointers to their respective cipher function. simple, clean, no surprises π
π SEE ALSO π
β HISTORY β
All of these functions were deprecated in OpenSSL 3.0.
The functions described here were added in OpenSSL 1.1.0. The EVP_CIPHER structure created with these functions became reference counted in OpenSSL 3.0. she grew up, got a refcount, and got deprecated all in the space of a couple versions π
π COPYRIGHT π
Copyright 2016-2024 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.
and that's the page, bestie π β this lil writeup is from 3.5.0, dated 2026-09-25, so go forth and don't build new stuff out of deprecated cipher methods, mwah ππ§
π¦ where this page comes from
- opensuse-leap 16.0: openssl-3-doc 3.5.0-160000.11.1 Β· Apache-2.0
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms