5 EVP_CIPHER_meth_new, EVP_CIPHER_meth_dup, EVP_CIPHER_meth_free,
6 EVP_CIPHER_meth_set_iv_length, EVP_CIPHER_meth_set_flags,
7 EVP_CIPHER_meth_set_impl_ctx_size, EVP_CIPHER_meth_set_init,
8 EVP_CIPHER_meth_set_do_cipher, EVP_CIPHER_meth_set_cleanup,
9 EVP_CIPHER_meth_set_set_asn1_params, EVP_CIPHER_meth_set_get_asn1_params,
10 EVP_CIPHER_meth_set_ctrl, EVP_CIPHER_meth_get_init,
11 EVP_CIPHER_meth_get_do_cipher, EVP_CIPHER_meth_get_cleanup,
12 EVP_CIPHER_meth_get_set_asn1_params, EVP_CIPHER_meth_get_get_asn1_params,
13 EVP_CIPHER_meth_get_ctrl
14 - Routines to build up EVP_CIPHER methods
18 #include <openssl/evp.h>
20 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
21 B<OPENSSL_API_COMPAT> with a suitable version value, see
22 L<openssl_user_macros(7)>:
24 EVP_CIPHER *EVP_CIPHER_meth_new(int cipher_type, int block_size, int key_len);
25 EVP_CIPHER *EVP_CIPHER_meth_dup(const EVP_CIPHER *cipher);
26 void EVP_CIPHER_meth_free(EVP_CIPHER *cipher);
28 int EVP_CIPHER_meth_set_iv_length(EVP_CIPHER *cipher, int iv_len);
29 int EVP_CIPHER_meth_set_flags(EVP_CIPHER *cipher, unsigned long flags);
30 int EVP_CIPHER_meth_set_impl_ctx_size(EVP_CIPHER *cipher, int ctx_size);
31 int EVP_CIPHER_meth_set_init(EVP_CIPHER *cipher,
32 int (*init)(EVP_CIPHER_CTX *ctx,
33 const unsigned char *key,
34 const unsigned char *iv,
36 int EVP_CIPHER_meth_set_do_cipher(EVP_CIPHER *cipher,
37 int (*do_cipher)(EVP_CIPHER_CTX *ctx,
39 const unsigned char *in,
41 int EVP_CIPHER_meth_set_cleanup(EVP_CIPHER *cipher,
42 int (*cleanup)(EVP_CIPHER_CTX *));
43 int EVP_CIPHER_meth_set_set_asn1_params(EVP_CIPHER *cipher,
44 int (*set_asn1_parameters)(EVP_CIPHER_CTX *,
46 int EVP_CIPHER_meth_set_get_asn1_params(EVP_CIPHER *cipher,
47 int (*get_asn1_parameters)(EVP_CIPHER_CTX *,
49 int EVP_CIPHER_meth_set_ctrl(EVP_CIPHER *cipher,
50 int (*ctrl)(EVP_CIPHER_CTX *, int type,
53 int (*EVP_CIPHER_meth_get_init(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *ctx,
54 const unsigned char *key,
55 const unsigned char *iv,
57 int (*EVP_CIPHER_meth_get_do_cipher(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *ctx,
59 const unsigned char *in,
61 int (*EVP_CIPHER_meth_get_cleanup(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *);
62 int (*EVP_CIPHER_meth_get_set_asn1_params(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *,
64 int (*EVP_CIPHER_meth_get_get_asn1_params(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *,
66 int (*EVP_CIPHER_meth_get_ctrl(const EVP_CIPHER *cipher))(EVP_CIPHER_CTX *,
72 All of the functions described on this page are deprecated.
73 Applications should instead use the OSSL_PROVIDER APIs.
75 The B<EVP_CIPHER> type is a structure for symmetric cipher method
78 EVP_CIPHER_meth_new() creates a new B<EVP_CIPHER> structure.
80 EVP_CIPHER_meth_dup() creates a copy of B<cipher>.
82 EVP_CIPHER_meth_free() destroys a B<EVP_CIPHER> structure.
84 EVP_CIPHER_meth_set_iv_length() sets the length of the IV.
85 This is only needed when the implemented cipher mode requires it.
87 EVP_CIPHER_meth_set_flags() sets the flags to describe optional
88 behaviours in the particular B<cipher>.
89 With the exception of cipher modes, of which only one may be present,
90 several flags can be or'd together.
91 The available flags are:
95 =item EVP_CIPH_STREAM_CIPHER, EVP_CIPH_ECB_MODE EVP_CIPH_CBC_MODE,
96 EVP_CIPH_CFB_MODE, EVP_CIPH_OFB_MODE, EVP_CIPH_CTR_MODE, EVP_CIPH_GCM_MODE,
97 EVP_CIPH_CCM_MODE, EVP_CIPH_XTS_MODE, EVP_CIPH_WRAP_MODE,
98 EVP_CIPH_OCB_MODE, EVP_CIPH_SIV_MODE
102 =item EVP_CIPH_VARIABLE_LENGTH
104 This cipher is of variable length.
106 =item EVP_CIPH_CUSTOM_IV
108 Storing and initialising the IV is left entirely to the
111 =item EVP_CIPH_ALWAYS_CALL_INIT
113 Set this if the implementation's init() function should be called even
114 if B<key> is B<NULL>.
116 =item EVP_CIPH_CTRL_INIT
118 Set this to have the implementation's ctrl() function called with
119 command code B<EVP_CTRL_INIT> early in its setup.
121 =item EVP_CIPH_CUSTOM_KEY_LENGTH
123 Checking and setting the key length after creating the B<EVP_CIPHER>
124 is left to the implementation.
125 Whenever someone uses EVP_CIPHER_CTX_set_key_length() on a
126 B<EVP_CIPHER> with this flag set, the implementation's ctrl() function
127 will be called with the control code B<EVP_CTRL_SET_KEY_LENGTH> and
128 the key length in B<arg>.
130 =item EVP_CIPH_NO_PADDING
132 Don't use standard block padding.
134 =item EVP_CIPH_RAND_KEY
136 Making a key with random content is left to the implementation.
137 This is done by calling the implementation's ctrl() function with the
138 control code B<EVP_CTRL_RAND_KEY> and the pointer to the key memory
141 =item EVP_CIPH_CUSTOM_COPY
143 Set this to have the implementation's ctrl() function called with
144 command code B<EVP_CTRL_COPY> at the end of EVP_CIPHER_CTX_copy().
145 The intended use is for further things to deal with after the
146 implementation specific data block has been copied.
147 The destination B<EVP_CIPHER_CTX> is passed to the control with the
149 The implementation specific data block is reached with
150 EVP_CIPHER_CTX_get_cipher_data().
152 =item EVP_CIPH_FLAG_DEFAULT_ASN1
154 Use the default EVP routines to pass IV to and from ASN.1.
156 =item EVP_CIPH_FLAG_LENGTH_BITS
158 Signals that the length of the input buffer for encryption /
159 decryption is to be understood as the number of bits instead of
160 bytes for this implementation.
161 This is only useful for CFB1 ciphers.
163 =item EVP_CIPH_FLAG_CTS
165 Indicates that the cipher uses ciphertext stealing. This is currently
166 used to indicate that the cipher is a one shot that only allows a single call to
169 =item EVP_CIPH_FLAG_CUSTOM_CIPHER
171 This indicates that the implementation takes care of everything,
172 including padding, buffering and finalization.
173 The EVP routines will simply give them control and do nothing more.
175 =item EVP_CIPH_FLAG_AEAD_CIPHER
177 This indicates that this is an AEAD cipher implementation.
179 =item EVP_CIPH_FLAG_TLS1_1_MULTIBLOCK
181 Allow interleaving of crypto blocks, a particular optimization only applicable
182 to certain TLS ciphers.
186 EVP_CIPHER_meth_set_impl_ctx_size() sets the size of the EVP_CIPHER's
187 implementation context so that it can be automatically allocated.
189 EVP_CIPHER_meth_set_init() sets the cipher init function for
191 The cipher init function is called by EVP_CipherInit(),
192 EVP_CipherInit_ex(), EVP_EncryptInit(), EVP_EncryptInit_ex(),
193 EVP_DecryptInit(), EVP_DecryptInit_ex().
195 EVP_CIPHER_meth_set_do_cipher() sets the cipher function for
197 The cipher function is called by EVP_CipherUpdate(),
198 EVP_EncryptUpdate(), EVP_DecryptUpdate(), EVP_CipherFinal(),
199 EVP_EncryptFinal(), EVP_EncryptFinal_ex(), EVP_DecryptFinal() and
200 EVP_DecryptFinal_ex().
202 EVP_CIPHER_meth_set_cleanup() sets the function for B<cipher> to do
203 extra cleanup before the method's private data structure is cleaned
205 Note that the cleanup function is passed a B<EVP_CIPHER_CTX *>, the
206 private data structure is then available with
207 EVP_CIPHER_CTX_get_cipher_data().
208 This cleanup function is called by EVP_CIPHER_CTX_reset() and
209 EVP_CIPHER_CTX_free().
211 EVP_CIPHER_meth_set_set_asn1_params() sets the function for B<cipher>
212 to set the AlgorithmIdentifier "parameter" based on the passed cipher.
213 This function is called by EVP_CIPHER_param_to_asn1().
214 EVP_CIPHER_meth_set_get_asn1_params() sets the function for B<cipher>
215 that sets the cipher parameters based on an ASN.1 AlgorithmIdentifier
217 Both these functions are needed when there is a need for custom data
218 (more or other than the cipher IV).
219 They are called by EVP_CIPHER_param_to_asn1() and
220 EVP_CIPHER_asn1_to_param() respectively if defined.
222 EVP_CIPHER_meth_set_ctrl() sets the control function for B<cipher>.
224 EVP_CIPHER_meth_get_init(), EVP_CIPHER_meth_get_do_cipher(),
225 EVP_CIPHER_meth_get_cleanup(), EVP_CIPHER_meth_get_set_asn1_params(),
226 EVP_CIPHER_meth_get_get_asn1_params() and EVP_CIPHER_meth_get_ctrl()
227 are all used to retrieve the method data given with the
228 EVP_CIPHER_meth_set_*() functions above.
232 EVP_CIPHER_meth_new() and EVP_CIPHER_meth_dup() return a pointer to a
233 newly created B<EVP_CIPHER>, or NULL on failure.
234 All EVP_CIPHER_meth_set_*() functions return 1.
235 All EVP_CIPHER_meth_get_*() functions return pointers to their
236 respective B<cipher> function.
240 L<EVP_EncryptInit(3)>
244 All of these functions were deprecated in OpenSSL 3.0.
246 The functions described here were added in OpenSSL 1.1.0.
247 The B<EVP_CIPHER> structure created with these functions became reference
248 counted in OpenSSL 3.0.
252 Copyright 2016-2020 The OpenSSL Project Authors. All Rights Reserved.
254 Licensed under the Apache License 2.0 (the "License"). You may not use
255 this file except in compliance with the License. You can obtain a copy
256 in the file LICENSE in the source distribution or at
257 L<https://www.openssl.org/source/license.html>.