5 migration_guide - OpenSSL migration guide
9 See the individual manual pages for details.
13 This guide details the changes required to migrate to new versions of OpenSSL.
14 Currently this covers OpenSSL 3.0. For earlier versions refer to
15 L<https://github.com/openssl/openssl/blob/master/CHANGES.md>.
16 For an overview of some of the key concepts introduced in OpenSSL 3.0 see
21 =head2 Main Changes from OpenSSL 1.1.1
25 OpenSSL 3.0 is a major release and consequently any application that currently
26 uses an older version of OpenSSL will at the very least need to be recompiled in
27 order to work with the new version. It is the intention that the large majority
28 of applications will work unchanged with OpenSSL 3.0 if those applications
29 previously worked with OpenSSL 1.1.1. However this is not guaranteed and some
30 changes may be required in some cases. Changes may also be required if
31 applications need to take advantage of some of the new features available in
32 OpenSSL 3.0 such as the availability of the FIPS module.
36 In previous versions, OpenSSL was licensed under the L<dual OpenSSL and SSLeay
37 licenses|https://www.openssl.org/source/license-openssl-ssleay.txt>
38 (both licenses apply). From OpenSSL 3.0 this is replaced by the
39 L<Apache License v2|https://www.openssl.org/source/apache-license-2.0.txt>.
41 =head3 Providers and FIPS support
43 One of the key changes from OpenSSL 1.1.1 is the introduction of the Provider
44 concept. Providers collect together and make available algorithm implementations.
45 With OpenSSL 3.0 it is possible to specify, either programmatically or via a
46 config file, which providers you want to use for any given application.
47 OpenSSL 3.0 comes with 5 different providers as standard. Over time third
48 parties may distribute additional providers that can be plugged into OpenSSL.
49 All algorithm implementations available via providers are accessed through the
50 "high level" APIs (for example those functions prefixed with C<EVP>). They cannot
51 be accessed using the L</Low Level APIs>.
53 One of the standard providers available is the FIPS provider. This makes
54 available FIPS validated cryptographic algorithms.
55 The FIPS provider is disabled by default and needs to be enabled explicitly
56 at configuration time using the C<enable-fips> option. If it is enabled,
57 the FIPS provider gets built and installed in addition to the other standard
58 providers. No separate installation procedure is necessary.
59 There is however a dedicated C<install_fips> make target, which serves the
60 special purpose of installing only the FIPS provider into an existing
63 Not all algorithms may be available for the application at a particular moment.
64 If the application code uses any digest or cipher algorithm via the EVP interface,
65 the application should verify the result of the L<EVP_EncryptInit(3)>,
66 L<EVP_EncryptInit_ex(3)>, and L<EVP_DigestInit(3)> functions. In case when
67 the requested algorithm is not available, these functions will fail.
69 See also L</Legacy Algorithms> for information on the legacy provider.
71 See also L</Completing the installation of the FIPS Module> and
72 L</Using the FIPS Module in applications>.
76 OpenSSL has historically provided two sets of APIs for invoking cryptographic
77 algorithms: the "high level" APIs (such as the C<EVP> APIs) and the "low level"
78 APIs. The high level APIs are typically designed to work across all algorithm
79 types. The "low level" APIs are targeted at a specific algorithm implementation.
80 For example, the EVP APIs provide the functions L<EVP_EncryptInit_ex(3)>,
81 L<EVP_EncryptUpdate(3)> and L<EVP_EncryptFinal(3)> to perform symmetric
82 encryption. Those functions can be used with the algorithms AES, CHACHA, 3DES etc.
83 On the other hand, to do AES encryption using the low level APIs you would have
84 to call AES specific functions such as L<AES_set_encrypt_key(3)>,
85 L<AES_encrypt(3)>, and so on. The functions for 3DES are different.
86 Use of the low level APIs has been informally discouraged by the OpenSSL
87 development team for a long time. However in OpenSSL 3.0 this is made more
88 formal. All such low level APIs have been deprecated. You may still use them in
89 your applications, but you may start to see deprecation warnings during
90 compilation (dependent on compiler support for this). Deprecated APIs may be
91 removed from future versions of OpenSSL so you are strongly encouraged to update
92 your code to use the high level APIs instead.
94 This is described in more detail in L</Deprecation of Low Level Functions>
96 =head3 Legacy Algorithms
98 Some cryptographic algorithms such as B<MD2> and B<DES> that were available via
99 the EVP APIs are now considered legacy and their use is strongly discouraged.
100 These legacy EVP algorithms are still available in OpenSSL 3.0 but not by
101 default. If you want to use them then you must load the legacy provider.
102 This can be as simple as a config file change, or can be done programmatically.
103 See L<OSSL_PROVIDER-legacy(7)> for a complete list of algorithms.
104 Applications using the EVP APIs to access these algorithms should instead use
105 more modern algorithms. If that is not possible then these applications
106 should ensure that the legacy provider has been loaded. This can be achieved
107 either programmatically or via configuration. See L<crypto(7)> man page for
108 more information about providers.
110 =head3 Engines and "METHOD" APIs
112 The refactoring to support Providers conflicts internally with the APIs used to
113 support engines, including the ENGINE API and any function that creates or
114 modifies custom "METHODS" (for example L<EVP_MD_meth_new(3)>,
115 L<EVP_CIPHER_meth_new(3)>, L<EVP_PKEY_meth_new(3)>, L<RSA_meth_new(3)>,
116 L<EC_KEY_METHOD_new(3)>, etc.). These functions are being deprecated in
117 OpenSSL 3.0, and users of these APIs should know that their use can likely
118 bypass provider selection and configuration, with unintended consequences.
119 This is particularly relevant for applications written to use the OpenSSL 3.0
120 FIPS module, as detailed below. Authors and maintainers of external engines are
121 strongly encouraged to refactor their code transforming engines into providers
122 using the new Provider API and avoiding deprecated methods.
124 =head3 Versioning Scheme
126 The OpenSSL versioning scheme has changed with the OpenSSL 3.0 release. The new
127 versioning scheme has this format:
131 For OpenSSL 1.1.1 and below, different patch levels were indicated by a letter
132 at the end of the release version number. This will no longer be used and
133 instead the patch level is indicated by the final number in the version. A
134 change in the second (MINOR) number indicates that new features may have been
135 added. OpenSSL versions with the same major number are API and ABI compatible.
136 If the major number changes then API and ABI compatibility is not guaranteed.
138 For more information, see L<OpenSSL_version(3)>.
140 =head3 Other major new features
142 =head4 Certificate Management Protocol (CMP, RFC 4210)
144 This also covers CRMF (RFC 4211) and HTTP transfer (RFC 6712)
145 See L<openssl-cmp(1)> and L<OSSL_CMP_exec_certreq(3)> as starting points.
147 =head4 HTTP(S) client
149 A proper HTTP(S) client that supports GET and POST, redirection, plain and
150 ASN.1-encoded contents, proxies, and timeouts.
152 =head4 Key Derivation Function API (EVP_KDF)
154 This simplifies the process of adding new KDF and PRF implementations.
156 Previously KDF algorithms had been shoe-horned into using the EVP_PKEY object
157 which was not a logical mapping.
158 Existing applications that use KDF algorithms using EVP_PKEY
159 (scrypt, TLS1 PRF and HKDF) may be slower as they use an EVP_KDF bridge
161 All new applications should use the new L<EVP_KDF(3)> interface.
162 See also L<OSSL_PROVIDER-default(7)/Key Derivation Function (KDF)> and
163 L<OSSL_PROVIDER-FIPS(7)/Key Derivation Function (KDF)>.
165 =head4 Message Authentication Code API (EVP_MAC)
167 This simplifies the process of adding MAC implementations.
169 This includes a generic EVP_PKEY to EVP_MAC bridge, to facilitate the continued
170 use of MACs through raw private keys in functionality such as
171 L<EVP_DigestSign(3)> and L<EVP_DigestVerify(3)>.
173 All new applications should use the new L<EVP_MAC(3)> interface.
174 See also L<OSSL_PROVIDER-default(7)/Message Authentication Code (MAC)>
175 and L<OSSL_PROVIDER-FIPS(7)/Message Authentication Code (MAC)>.
177 =head4 Support for Linux Kernel TLS
179 In order to use KTLS, support for it must be compiled in using the
180 C<enable-ktls> configuration option. It must also be enabled at run time using
181 the B<SSL_OP_ENABLE_KTLS> option.
183 =head4 New Algorithms
189 KDF algorithms "SINGLE STEP" and "SSH"
191 See L<EVP_KDF-SS(7)> and L<EVP_KDF-SSHKDF(7)>
195 MAC Algorithms "GMAC" and "KMAC"
197 See L<EVP_MAC-GMAC(7)> and L<EVP_MAC-KMAC(7)>.
201 KEM Algorithm "RSASVE"
203 See L<EVP_KEM-RSA(7)>.
207 Cipher Algorithm "AES-SIV"
209 See L<EVP_EncryptInit(3)/SIV Mode>.
213 AES Key Wrap inverse ciphers supported by EVP layer.
215 The inverse ciphers use AES decryption for wrapping, and AES encryption for
216 unwrapping. The algorithms are: "AES-128-WRAP-INV", "AES-192-WRAP-INV",
217 "AES-256-WRAP-INV", "AES-128-WRAP-PAD-INV", "AES-192-WRAP-PAD-INV" and
218 "AES-256-WRAP-PAD-INV".
220 =item AES CTS cipher added to EVP layer.
222 The algorithms are "AES-128-CBC-CTS", "AES-192-CBC-CTS" and "AES-256-CBC-CTS".
223 CS1, CS2 and CS3 variants are supported.
227 =head4 CMS and PKCS#7 updates
233 Added CAdES-BES signature verification support.
237 Added CAdES-BES signature scheme and attributes support (RFC 5126) to CMS API.
241 Added AuthEnvelopedData content type structure (RFC 5083) using AES_GCM
243 This uses the AES-GCM parameter (RFC 5084) for the Cryptographic Message Syntax.
244 Its purpose is to support encryption and decryption of a digital envelope that
245 is both authenticated and encrypted using AES GCM mode.
249 L<PKCS7_get_octet_string(3)> and L<PKCS7_type_is_other(3)> were made public.
253 =head4 PKCS#12 API updates
255 The default algorithms for pkcs12 creation with the PKCS12_create() function
256 were changed to more modern PBKDF2 and AES based algorithms. The default
257 MAC iteration count was changed to PKCS12_DEFAULT_ITER to make it equal
258 with the password-based encryption iteration count. The default digest
259 algorithm for the MAC computation was changed to SHA-256. The pkcs12
260 application now supports -legacy option that restores the previous
261 default algorithms to support interoperability with legacy systems.
263 Added enhanced PKCS#12 APIs which accept a library context B<OSSL_LIB_CTX>
264 and (where relevant) a property query. Other APIs which handle PKCS#7 and
265 PKCS#8 objects have also been enhanced where required. This includes:
267 L<PKCS12_add_key_ex(3)>, L<PKCS12_add_safe_ex(3)>, L<PKCS12_add_safes_ex(3)>,
268 L<PKCS12_create_ex(3)>, L<PKCS12_decrypt_skey_ex(3)>, L<PKCS12_init_ex(3)>,
269 L<PKCS12_item_decrypt_d2i_ex(3)>, L<PKCS12_item_i2d_encrypt_ex(3)>,
270 L<PKCS12_key_gen_asc_ex(3)>, L<PKCS12_key_gen_uni_ex(3)>, L<PKCS12_key_gen_utf8_ex(3)>,
271 L<PKCS12_pack_p7encdata_ex(3)>, L<PKCS12_pbe_crypt_ex(3)>, L<PKCS12_PBE_keyivgen_ex(3)>,
272 L<PKCS12_SAFEBAG_create_pkcs8_encrypt_ex(3)>, L<PKCS5_pbe2_set_iv_ex(3)>,
273 L<PKCS5_pbe_set0_algor_ex(3)>, L<PKCS5_pbe_set_ex(3)>, L<PKCS5_pbkdf2_set_ex(3)>,
274 L<PKCS5_v2_PBE_keyivgen_ex(3)>, L<PKCS5_v2_scrypt_keyivgen_ex(3)>,
275 L<PKCS8_decrypt_ex(3)>, L<PKCS8_encrypt_ex(3)>, L<PKCS8_set0_pbe_ex(3)>.
277 As part of this change the EVP_PBE_xxx APIs can also accept a library
278 context and property query and will call an extended version of the key/IV
279 derivation function which supports these parameters. This includes
280 L<EVP_PBE_CipherInit_ex(3)>, L<EVP_PBE_find_ex(3)> and L<EVP_PBE_scrypt_ex(3)>.
282 =head4 Windows thread synchronization changes
284 Windows thread synchronization uses read/write primitives (SRWLock) when
285 supported by the OS, otherwise CriticalSection continues to be used.
289 A new generic trace API has been added which provides support for enabling
290 instrumentation through trace output. This feature is mainly intended as an aid
291 for developers and is disabled by default. To utilize it, OpenSSL needs to be
292 configured with the C<enable-trace> option.
294 If the tracing API is enabled, the application can activate trace output by
295 registering BIOs as trace channels for a number of tracing and debugging
296 categories. See L<OSSL_trace_enabled(3)>.
298 =head4 Key validation updates
300 L<EVP_PKEY_public_check(3)> and L<EVP_PKEY_param_check(3)> now work for
301 more key types. This includes RSA, DSA, ED25519, X25519, ED448 and X448.
302 Previously (in 1.1.1) they would return -2. For key types that do not have
303 parameters then L<EVP_PKEY_param_check(3)> will always return 1.
305 =head3 Other notable deprecations and changes
307 =head4 The function code part of an OpenSSL error code is no longer relevant
309 This code is now always set to zero. Related functions are deprecated.
311 =head4 STACK and HASH macros have been cleaned up
313 The type-safe wrappers are declared everywhere and implemented once.
314 See L<DEFINE_STACK_OF(3)> and L<DECLARE_LHASH_OF(3)>.
316 =head4 The RAND_DRBG subsystem has been removed
318 The new L<EVP_RAND(3)> is a partial replacement: the DRBG callback framework is
319 absent. The RAND_DRBG API did not fit well into the new provider concept as
320 implemented by EVP_RAND and EVP_RAND_CTX.
322 =head4 Removed FIPS_mode() and FIPS_mode_set()
324 These functions are legacy APIs that are not applicable to the new provider
325 model. Applications should instead use
326 L<EVP_default_properties_is_fips_enabled(3)> and
327 L<EVP_default_properties_enable_fips(3)>.
329 =head4 Key generation is slower
331 The Miller-Rabin test now uses 64 rounds, which is used for all prime generation,
332 including RSA key generation. This affects the time for larger keys sizes.
334 The default key generation method for the regular 2-prime RSA keys was changed
335 to the FIPS 186-4 B.3.6 method (Generation of Probable Primes with Conditions
336 Based on Auxiliary Probable Primes). This method is slower than the original
339 =head4 Change PBKDF2 to conform to SP800-132 instead of the older PKCS5 RFC2898
341 This checks that the salt length is at least 128 bits, the derived key length is
342 at least 112 bits, and that the iteration count is at least 1000.
343 For backwards compatibility these checks are disabled by default in the
344 default provider, but are enabled by default in the fips provider.
346 To enable or disable the checks see B<OSSL_KDF_PARAM_PKCS5> in
347 L<EVP_KDF-PBKDF2(7)>. The parameter can be set using L<EVP_KDF_derive(3)>.
349 =head4 Enforce a minimum DH modulus size of 512 bits
351 Smaller sizes now result in an error.
353 =head4 SM2 key changes
355 EC EVP_PKEYs with the SM2 curve have been reworked to automatically become
356 EVP_PKEY_SM2 rather than EVP_PKEY_EC.
358 Unlike in previous OpenSSL versions, this means that applications cannot
359 call C<EVP_PKEY_set_alias_type(pkey, EVP_PKEY_SM2)> to get SM2 computations.
361 Parameter and key generation is also reworked to make it possible
362 to generate EVP_PKEY_SM2 parameters and keys. Applications must now generate
363 SM2 keys directly and must not create an EVP_PKEY_EC key first. It is no longer
364 possible to import an SM2 key with domain parameters other than the SM2 elliptic
367 Validation of SM2 keys has been separated from the validation of regular EC
368 keys, allowing to improve the SM2 validation process to reject loaded private
369 keys that are not conforming to the SM2 ISO standard.
370 In particular, a private scalar `k` outside the range `1 <= k < n-1` is now
373 =head4 EVP_PKEY_set_alias_type() method has been removed
375 This function made a B<EVP_PKEY> object mutable after it had been set up. In
376 OpenSSL 3.0 it was decided that a provided key should not be able to change its
377 type, so this function has been removed.
379 =head4 Functions that return an internal key should be treated as read only
381 Functions such as L<EVP_PKEY_get0_RSA(3)> behave slightly differently in
382 OpenSSL 3.0. Previously they returned a pointer to the low-level key used
383 internally by libcrypto. From OpenSSL 3.0 this key may now be held in a
384 provider. Calling these functions will only return a handle on the internal key
385 where the EVP_PKEY was constructed using this key in the first place, for
386 example using a function or macro such as L<EVP_PKEY_assign_RSA(3)>,
387 L<EVP_PKEY_set1_RSA(3)>, etc.
388 Where the EVP_PKEY holds a provider managed key, then these functions now return
389 a cached copy of the key. Changes to the internal provider key that take place
390 after the first time the cached key is accessed will not be reflected back in
391 the cached copy. Similarly any changes made to the cached copy by application
392 code will not be reflected back in the internal provider key.
394 For the above reasons the keys returned from these functions should typically be
395 treated as read-only. To emphasise this the value returned from
396 L<EVP_PKEY_get0_RSA(3)>, L<EVP_PKEY_get0_DSA(3)>, L<EVP_PKEY_get0_EC_KEY(3)> and
397 L<EVP_PKEY_get0_DH(3)> have been made const. This may break some existing code.
398 Applications broken by this change should be modified. The preferred solution is
399 to refactor the code to avoid the use of these deprecated functions. Failing
400 this the code should be modified to use a const pointer instead.
401 The L<EVP_PKEY_get1_RSA(3)>, L<EVP_PKEY_get1_DSA(3)>, L<EVP_PKEY_get1_EC_KEY(3)>
402 and L<EVP_PKEY_get1_DH(3)> functions continue to return a non-const pointer to
403 enable them to be "freed". However they should also be treated as read-only.
405 =head4 The public key check has moved from EVP_PKEY_derive() to EVP_PKEY_derive_set_peer()
407 This may mean result in an error in L<EVP_PKEY_derive_set_peer(3)> rather than
408 during L<EVP_PKEY_derive(3)>.
409 To disable this check use EVP_PKEY_derive_set_peer_ex(dh, peer, 0).
411 =head4 The print format has cosmetic changes for some functions
413 The output from numerous "printing" functions such as L<X509_signature_print(3)>,
414 L<X509_print_ex(3)>, L<X509_CRL_print_ex(3)>, and other similar functions has been
415 amended such that there may be cosmetic differences between the output
416 observed in 1.1.1 and 3.0. This also applies to the B<-text> output from the
417 B<openssl x509> and B<openssl crl> applications.
419 =head4 Interactive mode from the B<openssl> program has been removed
421 From now on, running it without arguments is equivalent to B<openssl help>.
423 =head4 The error return values from some control calls (ctrl) have changed
425 One significant change is that controls which used to return -2 for
426 invalid inputs, now return -1 indicating a generic error condition instead.
428 =head4 DH and DHX key types have different settable parameters
430 Previously (in 1.1.1) these conflicting parameters were allowed, but will now
431 result in errors. See L<EVP_PKEY-DH(7)> for further details. This affects the
432 behaviour of L<openssl-genpkey(1)> for DH parameter generation.
434 =head4 EVP_CIPHER_CTX_set_flags() ordering change
436 If using a cipher from a provider the B<EVP_CIPH_FLAG_LENGTH_BITS> flag can only
437 be set B<after> the cipher has been assigned to the cipher context.
438 See L<EVP_EncryptInit(3)/FLAGS> for more information.
440 =head2 Installation and Compilation
442 Please refer to the INSTALL.md file in the top of the distribution for
443 instructions on how to build and install OpenSSL 3.0. Please also refer to the
444 various platform specific NOTES files for your specific platform.
446 =head2 Upgrading from OpenSSL 1.1.1
448 Upgrading to OpenSSL 3.0 from OpenSSL 1.1.1 should be relatively straight
449 forward in most cases. The most likely area where you will encounter problems
450 is if you have used low level APIs in your code (as discussed above). In that
451 case you are likely to start seeing deprecation warnings when compiling your
452 application. If this happens you have 3 options:
458 Ignore the warnings. They are just warnings. The deprecated functions are still present and you may still use them. However be aware that they may be removed from a future version of OpenSSL.
462 Suppress the warnings. Refer to your compiler documentation on how to do this.
466 Remove your usage of the low level APIs. In this case you will need to rewrite your code to use the high level APIs instead
470 =head2 Upgrading from OpenSSL 1.0.2
472 Upgrading to OpenSSL 3.0 from OpenSSL 1.0.2 is likely to be significantly more
473 difficult. In addition to the issues discussed above in the section about
474 L</Upgrading from OpenSSL 1.1.1>, the main things to be aware of are:
480 The build and installation procedure has changed significantly.
482 Check the file INSTALL.md in the top of the installation for instructions on how
483 to build and install OpenSSL for your platform. Also read the various NOTES
484 files in the same directory, as applicable for your platform.
488 Many structures have been made opaque in OpenSSL 3.0.
490 The structure definitions have been removed from the public header files and
491 moved to internal header files. In practice this means that you can no longer
492 stack allocate some structures. Instead they must be heap allocated through some
493 function call (typically those function names have a C<_new> suffix to them).
494 Additionally you must use "setter" or "getter" functions to access the fields
495 within those structures.
497 For example code that previously looked like this:
501 /* This line will now generate compiler errors */
502 EVP_MD_CTX_init(&md_ctx);
504 The code needs to be amended to look like this:
507 md_ctx = EVP_MD_CTX_new();
510 EVP_MD_CTX_free(md_ctx);
514 Support for TLSv1.3 has been added.
516 This has a number of implications for SSL/TLS applications. See the
517 L<TLS1.3 page|https://wiki.openssl.org/index.php/TLS1.3> for further details.
521 More details about the breaking changes between OpenSSL versions 1.0.2 and 1.1.0
523 L<OpenSSL 1.1.0 Changes page|https://wiki.openssl.org/index.php/OpenSSL_1.1.0_Changes>.
525 =head3 Upgrading from the OpenSSL 2.0 FIPS Object Module
527 The OpenSSL 2.0 FIPS Object Module was a separate download that had to be built
528 separately and then integrated into your main OpenSSL 1.0.2 build.
529 In OpenSSL 3.0 the FIPS support is fully integrated into the mainline version of
530 OpenSSL and is no longer a separate download. For further information see
531 L</Completing the installation of the FIPS Module>.
533 The function calls FIPS_mode() and FIPS_mode_set() have been removed
534 from OpenSSL 3.0. You should rewrite your application to not use them.
535 See L<fips_module(7)> and L<OSSL_PROVIDER-FIPS(7)> for details.
537 =head2 Completing the installation of the FIPS Module
539 The FIPS Module will be built and installed automatically if FIPS support has
540 been configured. The current documentation can be found in the
541 L<README-FIPS|https://github.com/openssl/openssl/blob/master/README-FIPS.md> file.
545 Applications written to work with OpenSSL 1.1.1 will mostly just work with
546 OpenSSL 3.0. However changes will be required if you want to take advantage of
547 some of the new features that OpenSSL 3.0 makes available. In order to do that
548 you need to understand some new concepts introduced in OpenSSL 3.0.
549 Read L<crypto(7)/Library contexts> for further information.
551 =head3 Library Context
553 A library context allows different components of a complex application to each
554 use a different library context and have different providers loaded with
555 different configuration settings.
556 See L<crypto(7)/Library contexts> for further info.
558 If the user creates an B<OSSL_LIB_CTX> via L<OSSL_LIB_CTX_new(3)> then many
559 functions may need to be changed to pass additional parameters to handle the
562 =head4 Using a Library Context - Old functions that should be changed
564 If a library context is needed then all EVP_* digest functions that return a
565 B<const EVP_MD *> such as EVP_sha256() should be replaced with a call to
566 L<EVP_MD_fetch(3)>. See L<crypto(7)/ALGORITHM FETCHING>.
568 If a library context is needed then all EVP_* cipher functions that return a
569 B<const EVP_CIPHER *> such as EVP_aes_128_cbc() should be replaced vith a call to
570 L<EVP_CIPHER_fetch(3)>. See L<crypto(7)/ALGORITHM FETCHING>.
572 Some functions can be passed an object that has already been set up with a library
573 context such as L<d2i_X509(3)>, L<d2i_X509_CRL(3)>, L<d2i_X509_REQ(3)> and
574 L<d2i_X509_PUBKEY(3)>. If NULL is passed instead then the created object will be
575 set up with the default library context. Use L<X509_new_ex(3)>,
576 L<X509_CRL_new_ex(3)>, L<X509_REQ_new_ex(3)> and L<X509_PUBKEY_new_ex(3)> if a
577 library context is required.
579 All functions listed below with a I<NAME> have a replacment function I<NAME_ex>
580 that takes B<OSSL_LIB_CTX> as an additional argument. Functions that have other
581 mappings are listed along with the respective name.
587 L<ASN1_item_new(3)>, L<ASN1_item_d2i(3)>, L<ASN1_item_d2i_fp(3)>,
588 L<ASN1_item_d2i_bio(3)>, L<ASN1_item_sign(3)> and L<ASN1_item_verify(3)>
596 b2i_RSA_PVK_bio() and i2b_PVK_bio()
600 L<BN_CTX_new(3)> and L<BN_CTX_secure_new(3)>
604 L<CMS_AuthEnvelopedData_create(3)>, L<CMS_ContentInfo_new(3)>, L<CMS_data_create(3)>,
605 L<CMS_digest_create(3)>, L<CMS_EncryptedData_encrypt(3)>, L<CMS_encrypt(3)>,
606 L<CMS_EnvelopedData_create(3)>, L<CMS_ReceiptRequest_create0(3)> and L<CMS_sign(3)>
610 L<CONF_modules_load_file(3)>
614 L<CTLOG_new(3)>, L<CTLOG_new_from_base64(3)> and L<CTLOG_STORE_new(3)>
618 L<CT_POLICY_EVAL_CTX_new(3)>
622 L<d2i_AutoPrivateKey(3)>, L<d2i_PrivateKey(3)> and L<d2i_PUBKEY(3)>
626 L<d2i_PrivateKey_bio(3)> and L<d2i_PrivateKey_fp(3)>
628 Use L<d2i_PrivateKey_ex_bio(3)> and L<d2i_PrivateKey_ex_fp(3)>
634 Use L<EC_GROUP_new_by_curve_name_ex(3)> or L<EC_GROUP_new_from_params(3)>.
638 L<EVP_DigestSignInit(3)> and L<EVP_DigestVerifyInit(3)>
642 L<EVP_PBE_CipherInit(3)>, L<EVP_PBE_find(3)> and L<EVP_PBE_scrypt(3)>
646 L<PKCS5_PBE_keyivgen(3)>
654 L<EVP_PKEY_CTX_new_id(3)>
656 Use L<EVP_PKEY_CTX_new_from_name(3)>
660 L<EVP_PKEY_derive_set_peer(3)>, L<EVP_PKEY_new_raw_private_key(3)>
661 and L<EVP_PKEY_new_raw_public_key(3)>
665 L<EVP_SignFinal(3)> and L<EVP_VerifyFinal(3)>
673 L<OCSP_RESPID_match(3)> and L<OCSP_RESPID_set_by_key(3)>
677 L<OPENSSL_thread_stop(3)>
681 L<OSSL_STORE_open(3)>
685 L<PEM_read_bio_Parameters(3)>, L<PEM_read_bio_PrivateKey(3)>, L<PEM_read_bio_PUBKEY(3)>,
686 L<PEM_read_PrivateKey(3)> and L<PEM_read_PUBKEY(3)>
690 L<PEM_write_bio_PrivateKey(3)>, L<PEM_write_bio_PUBKEY(3)>, L<PEM_write_PrivateKey(3)>
691 and L<PEM_write_PUBKEY(3)>
695 L<PEM_X509_INFO_read_bio(3)> and L<PEM_X509_INFO_read(3)>
699 L<PKCS12_add_key(3)>, L<PKCS12_add_safe(3)>, L<PKCS12_add_safes(3)>,
700 L<PKCS12_create(3)>, L<PKCS12_decrypt_skey(3)>, L<PKCS12_init(3)>, L<PKCS12_item_decrypt_d2i(3)>,
701 L<PKCS12_item_i2d_encrypt(3)>, L<PKCS12_key_gen_asc(3)>, L<PKCS12_key_gen_uni(3)>,
702 L<PKCS12_key_gen_utf8(3)>, L<PKCS12_pack_p7encdata(3)>, L<PKCS12_pbe_crypt(3)>,
703 L<PKCS12_PBE_keyivgen(3)>, L<PKCS12_SAFEBAG_create_pkcs8_encrypt(3)>
707 L<PKCS5_pbe_set0_algor(3)>, L<PKCS5_pbe_set(3)>, L<PKCS5_pbe2_set_iv(3)>,
708 L<PKCS5_pbkdf2_set(3)> and L<PKCS5_v2_scrypt_keyivgen(3)>
712 L<PKCS7_encrypt(3)>, L<PKCS7_new(3)> and L<PKCS7_sign(3)>
716 L<PKCS8_decrypt(3)>, L<PKCS8_encrypt(3)> and L<PKCS8_set0_pbe(3)>
720 L<RAND_bytes(3)> and L<RAND_priv_bytes(3)>
724 L<SMIME_write_ASN1(3)>
728 L<SSL_load_client_CA_file(3)>
736 L<TS_RESP_CTX_new(3)>
744 L<X509_load_cert_crl_file(3)> and L<X509_load_cert_file(3)>
748 L<X509_LOOKUP_by_subject(3)> and L<X509_LOOKUP_ctrl(3)>
760 L<X509_REQ_new(3)> and L<X509_REQ_verify(3)>
764 L<X509_STORE_CTX_new(3)>, L<X509_STORE_set_default_paths(3)>, L<X509_STORE_load_file(3)>,
765 L<X509_STORE_load_locations(3)> and L<X509_STORE_load_store(3)>
769 =head4 New functions that use a Library context
771 The following functions can be passed a library context if required.
772 Passing NULL will use the default library context.
778 L<BIO_new_from_core_bio(3)>
782 L<EVP_ASYM_CIPHER_fetch(3)> and L<EVP_ASYM_CIPHER_do_all_provided(3)>
786 L<EVP_CIPHER_fetch(3)> and L<EVP_CIPHER_do_all_provided(3)>
790 L<EVP_default_properties_enable_fips(3)> and
791 L<EVP_default_properties_is_fips_enabled(3)>
795 L<EVP_KDF_fetch(3)> and L<EVP_KDF_do_all_provided(3)>
799 L<EVP_KEM_fetch(3)> and L<EVP_KEM_do_all_provided(3)>
803 L<EVP_KEYEXCH_fetch(3)> and L<EVP_KEYEXCH_do_all_provided(3)>
807 L<EVP_KEYMGMT_fetch(3)> and L<EVP_KEYMGMT_do_all_provided(3)>
811 L<EVP_MAC_fetch(3)> and L<EVP_MAC_do_all_provided(3)>
815 L<EVP_MD_fetch(3)> and L<EVP_MD_do_all_provided(3)>
819 L<EVP_PKEY_CTX_new_from_pkey(3)>
823 L<EVP_PKEY_Q_keygen(3)>
827 L<EVP_Q_mac(3)> and L<EVP_Q_digest(3)>
831 L<EVP_RAND(3)> and L<EVP_RAND_do_all_provided(3)>
835 L<EVP_set_default_properties(3)>
839 L<EVP_SIGNATURE_fetch(3)> and L<EVP_SIGNATURE_do_all_provided(3)>
843 L<OSSL_CMP_CTX_new(3)> and L<OSSL_CMP_SRV_CTX_new(3)>
847 L<OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(3)>
851 L<OSSL_CRMF_MSG_create_popo(3)> and L<OSSL_CRMF_MSGS_verify_popo(3)>
855 L<OSSL_CRMF_pbm_new(3)> and L<OSSL_CRMF_pbmp_new(3)>
859 L<OSSL_DECODER_CTX_add_extra(3)> and L<OSSL_DECODER_CTX_new_for_pkey(3)>
863 L<OSSL_DECODER_fetch(3)> and L<OSSL_DECODER_do_all_provided(3)>
867 L<OSSL_ENCODER_CTX_add_extra(3)>
871 L<OSSL_ENCODER_fetch(3)> and L<OSSL_ENCODER_do_all_provided(3)>
875 L<OSSL_LIB_CTX_free(3)>, L<OSSL_LIB_CTX_load_config(3)> and L<OSSL_LIB_CTX_set0_default(3)>
879 L<OSSL_PROVIDER_add_builtin(3)>, L<OSSL_PROVIDER_available(3)>,
880 L<OSSL_PROVIDER_do_all(3)>, L<OSSL_PROVIDER_load(3)>,
881 L<OSSL_PROVIDER_set_default_search_path(3)> and L<OSSL_PROVIDER_try_load(3)>
885 L<OSSL_SELF_TEST_get_callback(3)> and L<OSSL_SELF_TEST_set_callback(3)>
889 L<OSSL_STORE_attach(3)>
893 L<OSSL_STORE_LOADER_fetch(3)> and L<OSSL_STORE_LOADER_do_all_provided(3)>
897 L<RAND_get0_primary(3)>, L<RAND_get0_private(3)>, L<RAND_get0_public(3)>,
898 L<RAND_set_DRBG_type(3)> and L<RAND_set_seed_source_type(3)>
904 Providers are described in detail here L<crypto(7)/Providers>.
905 See also L<crypto(7)/OPENSSL PROVIDERS>.
907 =head3 Fetching algorithms and property queries
909 Implicit and Explicit Fetching is described in detail here
910 L<crypto(7)/ALGORITHM FETCHING>.
912 =head3 Mapping EVP controls and flags to provider B<OSSL_PARAM> parameters
914 The existing functions for controls (such as L<EVP_CIPHER_CTX_ctrl(3)>) and
915 manipulating flags (such as L<EVP_MD_CTX_set_flags(3)>)internally use
916 B<OSSL_PARAMS> to pass information to/from provider objects.
917 See L<OSSL_PARAM(3)> for additional information related to parameters.
919 For ciphers see L<EVP_EncryptInit(3)/CONTROLS>, L<EVP_EncryptInit(3)/FLAGS> and
920 L<EVP_EncryptInit(3)/PARAMETERS>.
922 For digests see L<EVP_DigestInit(3)/CONTROLS>, L<EVP_DigestInit(3)/FLAGS> and
923 L<EVP_DigestInit(3)/PARAMETERS>.
925 =head3 Deprecation of Low Level Functions
927 A significant number of APIs have been deprecated in OpenSSL 3.0.
928 This section describes some common categories of deprecations.
929 See L</Deprecated function mappings> for the list of deprecated functions
930 that refer to these categories.
932 =head4 Providers are a replacement for engines and low-level method overrides
934 Any accessor that uses an ENGINE is deprecated (such as EVP_PKEY_set1_engine()).
935 Applications using engines should instead use providers.
937 Before providers were added algorithms were overriden by changing the methods
938 used by algorithms. All these methods such as RSA_new_method() and RSA_meth_new()
939 are now deprecated and can be replaced by using providers instead.
941 =head4 Deprecated i2d and d2i functions for low-level key types
943 Any i2d and d2i functions such as d2i_DHparams() that take a low-level key type
944 have been deprecated. Applications should instead use the L<OSSL_DECODER(3)> and
945 L<OSSL_ENCODER(3)> APIs to read and write files.
946 See L<d2i_RSAPrivateKey(3)/Migration> for further details.
948 =head4 Deprecated low-level key object getters and setters
950 Applications that set or get low-level key objects (such as EVP_PKEY_set1_DH()
951 or EVP_PKEY_get0()) should instead use the OSSL_ENCODER
952 (See L<OSSL_ENCODER_to_bio(3)>) or OSSL_DECODER (See L<OSSL_DECODER_from_bio(3)>)
953 APIs, or alternatively use L<EVP_PKEY_fromdata(3)> or L<EVP_PKEY_todata(3)>.
955 =head4 Deprecated low-level key parameter getters
957 Functions that access low-level objects directly such as L<RSA_get0_n(3)> are now
958 deprecated. Applications should use one of L<EVP_PKEY_get_bn_param(3)>,
959 L<EVP_PKEY_get_int_param(3)>, l<EVP_PKEY_get_size_t_param(3)>,
960 L<EVP_PKEY_get_utf8_string_param(3)>, L<EVP_PKEY_get_octet_string_param(3)> or
961 L<EVP_PKEY_get_params(3)> to access fields from an EVP_PKEY.
962 Gettable parameters are listed in L<EVP_PKEY-RSA(7)/Common RSA parameters>,
963 L<EVP_PKEY-DH(7)/DH parameters>, L<EVP_PKEY-DSA(7)/DSA parameters>,
964 L<EVP_PKEY-FFC(7)/FFC parameters>, L<EVP_PKEY-EC(7)/Common EC parameters> and
965 L<EVP_PKEY-X25519(7)/Common X25519, X448, ED25519 and ED448 parameters>.
966 Applications may also use L<EVP_PKEY_todata(3)> to return all fields.
968 =head4 Deprecated low-level key parameter setters
970 Functions that access low-level objects directly such as L<RSA_set0_crt_params(3)>
971 are now deprecated. Applications should use L<EVP_PKEY_fromdata(3)> to create
972 new keys from user provided key data. Keys should be immutable once they are
973 created, so if required the user may use L<EVP_PKEY_todata(3)>, L<OSSL_PARAM_merge(3)>,
974 and L<EVP_PKEY_fromdata(3)> to create a modified key.
975 See L<EVP_PKEY-DH(7)/Examples> for more information.
976 See L</Deprecated low-level key generation functions> for information on
977 generating a key using parameters.
979 =head4 Deprecated low-level object creation
981 Low-level objects were created using methods such as L<RSA_new(3)>,
982 L<RSA_up_ref(3)> and L<RSA_free(3)>. Applications should instead use the
983 high-level EVP_PKEY APIs, e.g. L<EVP_PKEY_new(3)>, L<EVP_PKEY_up_ref(3)> and
985 See also L<EVP_PKEY_CTX_new_from_name(3)> and L<EVP_PKEY_CTX_new_from_pkey(3)>.
987 EVP_PKEYs may be created in a variety of ways:
988 See also L</Deprecated low-level key generation functions>,
989 L</Deprecated low-level key reading and writing functions> and
990 L</Deprecated low-level key parameter setters>.
992 =head4 Deprecated low-level encryption functions
994 Low-level encryption functions such as L<AES_encrypt(3)> and L<AES_decrypt(3)>
995 have been informally discouraged from use for a long time. Applications should
996 instead use the high level EVP APIs L<EVP_EncryptInit_ex(3)>,
997 L<EVP_EncryptUpdate(3)>, and L<EVP_EncryptFinal_ex(3)> or
998 L<EVP_DecryptInit_ex(3)>, L<EVP_DecryptUpdate(3)> and L<EVP_DecryptFinal_ex(3)>.
1000 =head4 Deprecated low-level digest functions
1002 Use of low-level digest functions such as L<SHA1_Init(3)> have been
1003 informally discouraged from use for a long time. Applications should instead
1004 use the the high level EVP APIs L<EVP_DigestInit_ex(3)>, L<EVP_DigestUpdate(3)>
1005 and L<EVP_DigestFinal_ex(3)>, or the quick one-shot L<EVP_Q_digest(3)>.
1007 Note that the functions L<SHA1(3)>, L<SHA224(3)>, L<SHA256(3)>, L<SHA384(3)>
1008 and L<SHA512(3)> have changed to macros that use L<EVP_Q_digest(3)>.
1010 =head4 Deprecated low-level signing functions
1012 Use of low-level signing functions such as L<DSA_sign(3)> have been
1013 informally discouraged for a long time. Instead applications should use
1014 L<EVP_DigestSign(3)> and L<EVP_DigestVerify(3)>.
1015 See also L<EVP_SIGNATURE-RSA(7)>, L<EVP_SIGNATURE-DSA(7)>,
1016 L<EVP_SIGNATURE-ECDSA(7)> and L<EVP_SIGNATURE-ED25519(7)>.
1018 =head4 Deprecated low-level MAC functions
1020 Low-level mac functions such as L<CMAC_Init(3)> are deprecated.
1021 Applications should instead use the new L<EVP_MAC(3)> interface, using
1022 L<EVP_MAC_CTX_new(3)>, L<EVP_MAC_CTX_free(3)>, L<EVP_MAC_init(3)>,
1023 L<EVP_MAC_update(3)> and L<EVP_MAC_final(3)> or the single-shot MAC function
1025 See L<EVP_MAC(3)>, L<EVP_MAC-HMAC(7)>, L<EVP_MAC-CMAC(7)>, L<EVP_MAC-GMAC(7)>,
1026 L<EVP_MAC-KMAC(7)>, L<EVP_MAC-BLAKE2(7)>, L<EVP_MAC-Poly1305(7)> and
1027 L<EVP_MAC-Siphash(7)> for additional information.
1029 Note that the one-shot method HMAC() is still available for compatability purposes.
1031 =head4 Deprecated low-level validation functions
1033 Low-level validation functions such as L<DH_check(3)> have been informally
1034 discouraged from use for a long time. Applications should instead use the high-level
1035 EVP_PKEY APIs such as L<EVP_PKEY_check(3)>, L<EVP_PKEY_param_check(3)>,
1036 L<EVP_PKEY_param_check_quick(3)>, L<EVP_PKEY_public_check(3)>,
1037 L<EVP_PKEY_public_check_quick(3)>, L<EVP_PKEY_private_check(3)>,
1038 and L<EVP_PKEY_pairwise_check(3)>.
1040 =head4 Deprecated low-level key exchange functions
1042 Many low-level functions have been informally discouraged from use for a long
1043 time. Applications should instead use L<EVP_PKEY_derive(3)>.
1044 See L<EVP_KEYEXCH-DH(7)>, L<EVP_KEYEXCH-ECDH(7)> and L<EVP_KEYEXCH-X25519(7)>.
1046 =head4 Deprecated low-level key generation functions
1048 Many low-level functions have been informally discouraged from use for a long
1049 time. Applications should instead use L<EVP_PKEY_keygen_init(3)> and
1050 L<EVP_PKEY_generate(3)> as described in L<EVP_PKEY-DSA(7)>, L<EVP_PKEY-DH(7)>,
1051 L<EVP_PKEY-RSA(7)>, L<EVP_PKEY-EC(7)> and L<EVP_PKEY-X25519(7)>.
1052 The 'quick' one-shot function L<EVP_PKEY_Q_keygen(3)> and macros for the most
1053 common cases: <EVP_RSA_gen(3)> and L<EVP_EC_gen(3)> may also be used.
1055 =head4 Deprecated low-level key reading and writing functions
1057 Use of low-level objects (such as DSA) has been informally discouraged from use
1058 for a long time. Functions to read and write these low-level objects (such as
1059 PEM_read_DSA_PUBKEY()) should be replaced. Applications should instead use
1060 L<OSSL_ENCODER_to_bio(3)> and L<OSSL_DECODER_from_bio(3)>.
1062 =head4 Deprecated low-level key printing functions
1064 Use of low-level objects (such as DSA) has been informally discouraged from use
1065 for a long time. Functions to print these low-level objects such as
1066 DSA_print() should be replaced with the equivalent EVP_PKEY functions.
1067 Application should use one of L<EVP_PKEY_print_public(3)>,
1068 L<EVP_PKEY_print_private(3)>, L<EVP_PKEY_print_params(3)>,
1069 L<EVP_PKEY_print_public_fp(3)>, L<EVP_PKEY_print_private_fp(3)> or
1070 L<EVP_PKEY_print_params_fp(3)>. Note that internally these use
1071 L<OSSL_ENCODER_to_bio(3)> and L<OSSL_DECODER_from_bio(3)>.
1073 =head3 Deprecated function mappings
1075 The following functions have been deprecated in 3.0.
1081 AES_bi_ige_encrypt() and AES_ige_encrypt()
1083 There is no replacement for the IGE functions. New code should not use these modes.
1084 These undocumented functions were never integrated into the EVP layer.
1085 They implemented the AES Infinite Garble Extension (IGE) mode and AES
1086 Bi-directional IGE mode. These modes were never formally standardised and
1087 usage of these functions is believed to be very small. In particular
1088 AES_bi_ige_encrypt() has a known bug. It accepts 2 AES keys, but only one
1089 is ever used. The security implications are believed to be minimal, but
1090 this issue was never fixed for backwards compatibility reasons.
1094 AES_encrypt(), AES_decrypt(), AES_set_encrypt_key(), AES_set_decrypt_key(),
1095 AES_cbc_encrypt(), AES_cfb128_encrypt(), AES_cfb1_encrypt(), AES_cfb8_encrypt(),
1096 AES_ecb_encrypt(), AES_ofb128_encrypt()
1100 AES_unwrap_key(), AES_wrap_key()
1102 See L</Deprecated low-level encryption functions>
1108 There is no replacement. It returned a string indicating if the AES code was unrolled.
1112 ASN1_digest(), ASN1_sign(), ASN1_verify()
1114 There are no replacements. These old functions are not used, and could be
1115 disabled with the macro NO_ASN1_OLD since OpenSSL 0.9.7.
1119 ASN1_STRING_length_set()
1121 Use L<ASN1_STRING_set(3)> or L<ASN1_STRING_set0(3)> instead.
1122 This was a potentially unsafe function that could change the bounds of a
1123 previously passed in pointer.
1127 BF_encrypt(), BF_decrypt(), BF_set_key(), BF_cbc_encrypt(), BF_cfb64_encrypt(),
1128 BF_ecb_encrypt(), BF_ofb64_encrypt()
1130 See L</Deprecated low-level encryption functions>.
1131 The Blowfish algorithm has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1137 There is no replacement. This option returned a constant string.
1141 BIO_get_callback(), BIO_set_callback(), BIO_debug_callback()
1143 Use the respective non-deprecated _ex() functions.
1147 BN_is_prime_ex(), BN_is_prime_fasttest_ex()
1149 Use L<BN_check_prime(3)> which that avoids possible misuse and always uses at least
1150 64 rounds of the Miller-Rabin primality test.
1154 BN_pseudo_rand(), BN_pseudo_rand_range()
1156 Use L<BN_rand(3)> and L<BN_rand_range(3)>.
1160 BN_X931_derive_prime_ex(), BN_X931_generate_prime_ex(), BN_X931_generate_Xpq()
1162 There are no replacements for these low-level functions. They were used internally
1163 by RSA_X931_derive_ex() and RSA_X931_generate_key_ex() which are also deprecated.
1164 Use L<EVP_PKEY_keygen(3)> instead.
1168 Camellia_encrypt(), Camellia_decrypt(), Camellia_set_key(),
1169 Camellia_cbc_encrypt(), Camellia_cfb128_encrypt(), Camellia_cfb1_encrypt(),
1170 Camellia_cfb8_encrypt(), Camellia_ctr128_encrypt(), Camellia_ecb_encrypt(),
1171 Camellia_ofb128_encrypt()
1173 See L</Deprecated low-level encryption functions>.
1177 CAST_encrypt(), CAST_decrypt(), CAST_set_key(), CAST_cbc_encrypt(),
1178 CAST_cfb64_encrypt(), CAST_ecb_encrypt(), CAST_ofb64_encrypt()
1180 See L</Deprecated low-level encryption functions>.
1181 The CAST algorithm has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1185 CMAC_CTX_new(), CMAC_CTX_cleanup(), CMAC_CTX_copy(), CMAC_CTX_free(),
1186 CMAC_CTX_get0_cipher_ctx()
1188 See L</Deprecated low-level MAC functions>.
1192 CMAC_Init(), CMAC_Update(), CMAC_Final(), CMAC_resume()
1194 See L</Deprecated low-level MAC functions>.
1198 CRYPTO_mem_ctrl(), CRYPTO_mem_debug_free(), CRYPTO_mem_debug_malloc(),
1199 CRYPTO_mem_debug_pop(), CRYPTO_mem_debug_push(), CRYPTO_mem_debug_realloc(),
1200 CRYPTO_mem_leaks(), CRYPTO_mem_leaks_cb(), CRYPTO_mem_leaks_fp(),
1201 CRYPTO_set_mem_debug()
1203 Memory-leak checking has been deprecated in favor of more modern development
1204 tools, such as compiler memory and leak sanitizers or Valgrind.
1208 d2i_DHparams(), d2i_DHxparams(), d2i_DSAparams(), d2i_DSAPrivateKey(),
1209 d2i_DSAPrivateKey_bio(), d2i_DSAPrivateKey_fp(), d2i_DSA_PUBKEY(),
1210 d2i_DSA_PUBKEY_bio(), d2i_DSA_PUBKEY_fp(), d2i_DSAPublicKey(),
1211 d2i_ECParameters(), d2i_ECPrivateKey(), d2i_ECPrivateKey_bio(),
1212 d2i_ECPrivateKey_fp(), d2i_EC_PUBKEY(), d2i_EC_PUBKEY_bio(),
1213 d2i_EC_PUBKEY_fp(), o2i_ECPublicKey(), d2i_RSAPrivateKey(),
1214 d2i_RSAPrivateKey_bio(), d2i_RSAPrivateKey_fp(), d2i_RSA_PUBKEY(),
1215 d2i_RSA_PUBKEY_bio(), d2i_RSA_PUBKEY_fp(), d2i_RSAPublicKey(),
1216 d2i_RSAPublicKey_bio(), d2i_RSAPublicKey_fp()
1218 See L</Deprecated i2d and d2i functions for low-level key types>
1222 DES_crypt(), DES_fcrypt(), DES_encrypt1(), DES_encrypt2(), DES_encrypt3(),
1223 DES_decrypt3(), DES_ede3_cbc_encrypt(), DES_ede3_cfb64_encrypt(),
1224 DES_ede3_cfb_encrypt(),DES_ede3_ofb64_encrypt(),
1225 DES_ecb_encrypt(), DES_ecb3_encrypt(), DES_ofb64_encrypt(), DES_ofb_encrypt(),
1226 DES_cfb64_encrypt DES_cfb_encrypt(), DES_cbc_encrypt(), DES_ncbc_encrypt(),
1227 DES_pcbc_encrypt(), DES_xcbc_encrypt(), DES_cbc_cksum(), DES_quad_cksum(),
1228 DES_check_key_parity(), DES_is_weak_key(), DES_key_sched(), DES_options(),
1229 DES_random_key(), DES_set_key(), DES_set_key_checked(), DES_set_key_unchecked(),
1230 DES_set_odd_parity(), DES_string_to_2keys(), DES_string_to_key()
1232 See L</Deprecated low-level encryption functions>.
1233 Algorithms for "DESX-CBC", "DES-ECB", "DES-CBC", "DES-OFB", "DES-CFB",
1234 "DES-CFB1" and "DES-CFB8" have been moved to the L<Legacy Provider|/Legacy Algorithms>.
1238 DH_bits(), DH_security_bits(), DH_size()
1240 Use L<EVP_PKEY_get_bits(3)>, L<EVP_PKEY_get_security_bits(3)> and
1241 L<EVP_PKEY_get_size(3)>.
1245 DH_check(), DH_check_ex(), DH_check_params(), DH_check_params_ex(),
1246 DH_check_pub_key(), DH_check_pub_key_ex()
1248 See L</Deprecated low-level validation functions>
1252 DH_clear_flags(), DH_test_flags(), DH_set_flags()
1254 The B<DH_FLAG_CACHE_MONT_P> flag has been deprecated without replacement.
1255 The B<DH_FLAG_TYPE_DH> and B<DH_FLAG_TYPE_DHX> have been deprecated.
1256 Use EVP_PKEY_is_a() to determine the type of a key.
1257 There is no replacement for setting these flags.
1261 DH_compute_key() DH_compute_key_padded()
1263 See L</Deprecated low-level key exchange functions>.
1267 DH_new(), DH_new_by_nid(), DH_free(), DH_up_ref()
1269 See L</Deprecated low-level object creation>
1273 DH_generate_key(), DH_generate_parameters_ex()
1275 See L</Deprecated low-level key generation functions>.
1279 DH_get0_pqg(), DH_get0_p(), DH_get0_q(), DH_get0_g(), DH_get0_key(),
1280 DH_get0_priv_key(), DH_get0_pub_key(), DH_get_length(), DH_get_nid()
1282 See L</Deprecated low-level key parameter getters>
1286 DH_get_1024_160(), DH_get_2048_224(), DH_get_2048_256()
1288 Applications should instead set the B<OSSL_PKEY_PARAM_GROUP_NAME> as specified in
1289 L<EVP_PKEY-DH(7)/DH parameters>) to one of "dh_1024_160", "dh_2048_224" or
1290 "dh_2048_256" when generating a DH key.
1296 Applications should use L<EVP_PKEY_CTX_set_dh_kdf_type(3)> instead.
1300 DH_get_default_method(), DH_get0_engine(), DH_meth_*(), DH_new_method(),
1301 DH_OpenSSL(), DH_get_ex_data(), DH_set_default_method(), DH_set_method(),
1304 See L</Providers are a replacement for engines and low-level method overrides>
1308 DHparams_print(), DHparams_print_fp()
1310 See L</Deprecated low-level key printing functions>
1314 DH_set0_key(), DH_set0_pqg(), DH_set_length()
1316 See L</Deprecated low-level key parameter setters>
1320 DSA_bits(), DSA_security_bits(), DSA_size()
1322 Use L<EVP_PKEY_get_bits(3)>, L<EVP_PKEY_get_security_bits(3)> and
1323 L<EVP_PKEY_get_size(3)>.
1327 DHparams_dup(), DSA_dup_DH()
1329 There is no direct replacement. Applications may use L<EVP_PKEY_copy_parameters(3)>
1330 and L<EVP_PKEY_dup(3)> instead.
1334 DSA_generate_key(), DSA_generate_parameters_ex()
1336 See L</Deprecated low-level key generation functions>.
1340 DSA_get0_engine(), DSA_get_default_method(), DSA_get_ex_data(),
1341 DSA_get_method(), DSA_meth_*(), DSA_new_method(), DSA_OpenSSL(),
1342 DSA_set_default_method(), DSA_set_ex_data(), DSA_set_method()
1344 See L</Providers are a replacement for engines and low-level method overrides>.
1348 DSA_get0_p(), DSA_get0_q(), DSA_get0_g(), DSA_get0_pqg(), DSA_get0_key(),
1349 DSA_get0_priv_key(), DSA_get0_pub_key()
1351 See L</Deprecated low-level key parameter getters>.
1355 DSA_new(), DSA_free(), DSA_up_ref()
1357 See L</Deprecated low-level object creation>
1363 There is no direct replacement. Applications may use L<EVP_PKEY_copy_parameters(3)>
1364 and L<EVP_PKEY_dup(3)> instead.
1368 DSAparams_print(), DSAparams_print_fp(), DSA_print(), DSA_print_fp()
1370 See L</Deprecated low-level key printing functions>
1374 DSA_set0_key(), DSA_set0_pqg()
1376 See L</Deprecated low-level key parameter setters>
1380 DSA_set_flags(), DSA_clear_flags(), DSA_test_flags()
1382 The B<DSA_FLAG_CACHE_MONT_P> flag has been deprecated without replacement.
1386 DSA_sign(), DSA_do_sign(), DSA_sign_setup(), DSA_verify(), DSA_do_verify()
1388 See L</Deprecated low-level signing functions>.
1394 See L</Deprecated low-level key exchange functions>.
1400 Applications may either set this using the helper function
1401 L<EVP_PKEY_CTX_set_ecdh_kdf_type(3)> or by setting an B<OSSL_PARAM> using the
1402 "kdf-type" as shown in L<EVP_KEYEXCH-ECDH(7)/EXAMPLES>
1406 ECDSA_sign(), ECDSA_sign_ex(), ECDSA_sign_setup(), ECDSA_do_sign(),
1407 ECDSA_do_sign_ex(), ECDSA_verify(), ECDSA_do_verify()
1409 See L</Deprecated low-level signing functions>.
1415 Applications should use L<EVP_PKEY_get_size(3)>.
1419 EC_GF2m_simple_method(), EC_GFp_mont_method(), EC_GFp_nist_method(),
1420 EC_GFp_nistp224_method(), EC_GFp_nistp256_method(), EC_GFp_nistp521_method(),
1421 EC_GFp_simple_method()
1423 There are no replacements for these functions. Applications should rely on the
1424 library automatically assigning a suitable method internally when an EC_GROUP
1429 EC_GROUP_clear_free()
1431 Use L<EC_GROUP_free(3)> instead.
1435 EC_GROUP_get_curve_GF2m(), EC_GROUP_get_curve_GFp(), EC_GROUP_set_curve_GF2m(),
1436 EC_GROUP_set_curve_GFp()
1438 Applications should use L<EC_GROUP_get_curve(3)> and L<EC_GROUP_set_curve(3)>.
1442 EC_GROUP_have_precompute_mult(), EC_GROUP_precompute_mult(),
1443 EC_KEY_precompute_mult()
1445 These functions are not widely used. Applications should instead switch to
1446 named curves which OpenSSL has hardcoded lookup tables for.
1450 EC_GROUP_new(), EC_GROUP_method_of(), EC_POINT_method_of()
1452 EC_METHOD is now an internal-only concept and a suitable EC_METHOD is assigned
1453 internally without application intervention.
1454 Users of EC_GROUP_new() should switch to a different suitable constructor.
1460 Applications should use L<EVP_PKEY_can_sign(3)> instead.
1466 See L</Deprecated low-level validation functions>
1470 EC_KEY_set_flags(), EC_KEY_get_flags(), EC_KEY_clear_flags()
1472 See L<EVP_PKEY-EC(7)/Common EC parameters> which handles flags as seperate
1473 parameters for B<OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT>,
1474 B<OSSL_PKEY_PARAM_EC_GROUP_CHECK_TYPE>, B<OSSL_PKEY_PARAM_EC_ENCODING>,
1475 B<OSSL_PKEY_PARAM_USE_COFACTOR_ECDH> and
1476 B<OSSL_PKEY_PARAM_EC_INCLUDE_PUBLIC>.
1477 See also L<EVP_PKEY-EC(7)/EXAMPLES>
1481 EC_KEY_dup(), EC_KEY_copy()
1483 There is no direct replacement. Applications may use L<EVP_PKEY_copy_parameters(3)>
1484 and L<EVP_PKEY_dup(3)> instead.
1488 EC_KEY_decoded_from_explicit_params()
1490 There is no replacement.
1494 EC_KEY_generate_key()
1496 See L</Deprecated low-level key generation functions>.
1500 EC_KEY_get0_group(), EC_KEY_get0_private_key(), EC_KEY_get0_public_key(),
1501 EC_KEY_get_conv_form(), EC_KEY_get_enc_flags()
1503 See L</Deprecated low-level key parameter getters>.
1507 EC_KEY_get0_engine(), EC_KEY_get_default_method(), EC_KEY_get_method(),
1508 EC_KEY_new_method(), EC_KEY_get_ex_data(), EC_KEY_OpenSSL(),
1509 EC_KEY_set_ex_data(), EC_KEY_set_default_method(), EC_KEY_METHOD_*(),
1512 See L</Providers are a replacement for engines and low-level method overrides>
1516 EC_METHOD_get_field_type()
1518 Use L<EC_GROUP_get_field_type(3)> instead.
1519 See L</Providers are a replacement for engines and low-level method overrides>
1523 EC_KEY_key2buf(), EC_KEY_oct2key(), EC_KEY_oct2priv(), EC_KEY_priv2buf(),
1526 There are no replacements for these.
1530 EC_KEY_new(), EC_KEY_new_by_curve_name(), EC_KEY_free(), EC_KEY_up_ref()
1532 See L</Deprecated low-level object creation>
1536 EC_KEY_print(), EC_KEY_print_fp()
1538 See L</Deprecated low-level key printing functions>
1542 EC_KEY_set_asn1_flag(), EC_KEY_set_conv_form(), EC_KEY_set_enc_flags()
1544 See L</Deprecated low-level key parameter setters>.
1548 EC_KEY_set_group(), EC_KEY_set_private_key(), EC_KEY_set_public_key(),
1549 EC_KEY_set_public_key_affine_coordinates()
1551 See L</Deprecated low-level key parameter setters>.
1555 ECParameters_print(), ECParameters_print_fp(), ECPKParameters_print(),
1556 ECPKParameters_print_fp()
1558 See L</Deprecated low-level key printing functions>
1562 EC_POINT_bn2point(), EC_POINT_point2bn()
1564 These functions were not particularly useful, since EC point serialization
1565 formats are not individual big-endian integers.
1569 EC_POINT_get_affine_coordinates_GF2m(), EC_POINT_get_affine_coordinates_GFp(),
1570 EC_POINT_set_affine_coordinates_GF2m(), EC_POINT_set_affine_coordinates_GFp()
1572 Applications should use L<EC_POINT_get_affine_coordinates(3)> and
1573 L<EC_POINT_set_affine_coordinates(3)> instead.
1577 EC_POINT_get_Jprojective_coordinates_GFp(), EC_POINT_set_Jprojective_coordinates_GFp()
1579 These functions are not widely used. Applications should instead use the
1580 L<EC_POINT_set_affine_coordinates(3)> and L<EC_POINT_get_affine_coordinates(3)>
1585 EC_POINT_make_affine(), EC_POINTs_make_affine()
1587 There is no replacement. These functions were not widely used, and OpenSSL
1588 automatically performs this conversion when needed.
1592 EC_POINT_set_compressed_coordinates_GF2m(), EC_POINT_set_compressed_coordinates_GFp()
1594 Applications should use L<EC_POINT_set_compressed_coordinates(3)> instead.
1600 This function is not widely used. Applications should instead use the
1601 L<EC_POINT_mul(3)> function.
1607 All engine functions are deprecated. An engine should be rewritten as a provider.
1608 See L</Providers are a replacement for engines and low-level method overrides>.
1612 B<ERR_load_*()>, ERR_func_error_string(), ERR_get_error_line(),
1613 ERR_get_error_line_data(), ERR_get_state()
1615 OpenSSL now loads error strings automatically so these functions are not needed.
1619 ERR_peek_error_line_data(), ERR_peek_last_error_line_data()
1621 The new functions are L<ERR_peek_error_func(3)>, L<ERR_peek_last_error_func(3)>,
1622 L<ERR_peek_error_data(3)>, L<ERR_peek_last_error_data(3)>, L<ERR_get_error_all(3)>,
1623 L<ERR_peek_error_all(3)> and L<ERR_peek_last_error_all(3)>.
1624 Applications should use L<ERR_get_error_all(3)>, or pick information
1625 with ERR_peek functions and finish off with getting the error code by using
1626 L<ERR_get_error(3)>.
1630 EVP_CIPHER_CTX_iv(), EVP_CIPHER_CTX_iv_noconst(), EVP_CIPHER_CTX_original_iv()
1632 Applications should instead use L<EVP_CIPHER_CTX_get_updated_iv(3)>,
1633 L<EVP_CIPHER_CTX_get_updated_iv(3)> and L<EVP_CIPHER_CTX_get_original_iv(3)>
1635 See L<EVP_CIPHER_CTX_get_original_iv(3)> for further information.
1639 B<EVP_CIPHER_meth_*()>, EVP_MD_CTX_set_update_fn(), EVP_MD_CTX_update_fn(),
1642 See L</Providers are a replacement for engines and low-level method overrides>.
1646 EVP_PKEY_CTRL_PKCS7_ENCRYPT(), EVP_PKEY_CTRL_PKCS7_DECRYPT(),
1647 EVP_PKEY_CTRL_PKCS7_SIGN(), EVP_PKEY_CTRL_CMS_ENCRYPT(),
1648 EVP_PKEY_CTRL_CMS_DECRYPT(), and EVP_PKEY_CTRL_CMS_SIGN()
1650 These control operations are not invoked by the OpenSSL library anymore and
1651 are replaced by direct checks of the key operation against the key type
1652 when the operation is initialized.
1656 EVP_PKEY_CTX_get0_dh_kdf_ukm(), EVP_PKEY_CTX_get0_ecdh_kdf_ukm()
1658 See the "kdf-ukm" item in L<EVP_KEYEXCH-DH(7)/DH key exchange parameters> and
1659 L<EVP_KEYEXCH-ECDH(7)/ECDH Key Exchange parameters>.
1660 These functions are obsolete and should not be required.
1664 EVP_PKEY_CTX_set_rsa_keygen_pubexp()
1666 Applications should use L<EVP_PKEY_CTX_set1_rsa_keygen_pubexp(3)> instead.
1670 EVP_PKEY_cmp(), EVP_PKEY_cmp_parameters()
1672 Applications should use L<EVP_PKEY_eq(3)> and L<EVP_PKEY_parameters_eq(3)> instead.
1673 See L<EVP_PKEY_copy_parameters(3)> for further details.
1677 EVP_PKEY_encrypt_old(), EVP_PKEY_decrypt_old(),
1679 Applications should use L<EVP_PKEY_encrypt_init(3)> and L<EVP_PKEY_encrypt(3)> or
1680 L<EVP_PKEY_decrypt_init(3)> and L<EVP_PKEY_decrypt(3)> instead.
1686 This function returns NULL if the key comes from a provider.
1690 EVP_PKEY_get0_DH(), EVP_PKEY_get0_DSA(), EVP_PKEY_get0_EC_KEY(), EVP_PKEY_get0_RSA(),
1691 EVP_PKEY_get1_DH(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_EC_KEY and EVP_PKEY_get1_RSA(),
1692 EVP_PKEY_get0_hmac(), EVP_PKEY_get0_poly1305(), EVP_PKEY_get0_siphash()
1694 See L</Functions that return an internal key should be treated as read only>.
1698 B<EVP_PKEY_meth_*()>
1700 See L</Providers are a replacement for engines and low-level method overrides>.
1704 EVP_PKEY_new_CMAC_key()
1706 See L</Deprecated low-level MAC functions>.
1710 EVP_PKEY_assign(), EVP_PKEY_set1_DH(), EVP_PKEY_set1_DSA(),
1711 EVP_PKEY_set1_EC_KEY(), EVP_PKEY_set1_RSA()
1713 See L</Deprecated low-level key object getters and setters>
1717 EVP_PKEY_set1_tls_encodedpoint() EVP_PKEY_get1_tls_encodedpoint()
1719 These functions were previously used by libssl to set or get an encoded public
1720 key into/from an EVP_PKEY object. With OpenSSL 3.0 these are replaced by the more
1721 generic functions L<EVP_PKEY_set1_encoded_public_key(3)> and
1722 L<EVP_PKEY_get1_encoded_public_key(3)>.
1723 The old versions have been converted to deprecated macros that just call the
1728 EVP_PKEY_set1_engine(), EVP_PKEY_get0_engine()
1730 See L</Providers are a replacement for engines and low-level method overrides>.
1734 EVP_PKEY_set_alias_type()
1736 This function has been removed. There is no replacement.
1737 See L</EVP_PKEY_set_alias_type() method has been removed>
1741 HMAC_Init_ex(), HMAC_Update(), HMAC_Final(), HMAC_size()
1743 See L</Deprecated low-level MAC functions>.
1747 HMAC_CTX_new(), HMAC_CTX_free(), HMAC_CTX_copy(), HMAC_CTX_reset(),
1748 HMAC_CTX_set_flags(), HMAC_CTX_get_md()
1750 See L</Deprecated low-level MAC functions>.
1754 i2d_DHparams(), i2d_DHxparams()
1756 See L</Deprecated low-level key reading and writing functions>
1757 and L<d2i_RSAPrivateKey(3)/Migration>
1761 i2d_DSAparams(), i2d_DSAPrivateKey(), i2d_DSAPrivateKey_bio(),
1762 i2d_DSAPrivateKey_fp(), i2d_DSA_PUBKEY(), i2d_DSA_PUBKEY_bio(),
1763 i2d_DSA_PUBKEY_fp(), i2d_DSAPublicKey()
1765 See L</Deprecated low-level key reading and writing functions>
1766 and L<d2i_RSAPrivateKey(3)/Migration>
1770 i2d_ECParameters(), i2d_ECPrivateKey(), i2d_ECPrivateKey_bio(),
1771 i2d_ECPrivateKey_fp(), i2d_EC_PUBKEY(), i2d_EC_PUBKEY_bio(),
1772 i2d_EC_PUBKEY_fp(), i2o_ECPublicKey()
1774 See L</Deprecated low-level key reading and writing functions>
1775 and L<d2i_RSAPrivateKey(3)/Migration>
1779 i2d_RSAPrivateKey(), i2d_RSAPrivateKey_bio(), i2d_RSAPrivateKey_fp(),
1780 i2d_RSA_PUBKEY(), i2d_RSA_PUBKEY_bio(), i2d_RSA_PUBKEY_fp(),
1781 i2d_RSAPublicKey(), i2d_RSAPublicKey_bio(), i2d_RSAPublicKey_fp()
1783 See L</Deprecated low-level key reading and writing functions>
1784 and L<d2i_RSAPrivateKey(3)/Migration>
1788 IDEA_encrypt(), IDEA_set_decrypt_key(), IDEA_set_encrypt_key(),
1789 IDEA_cbc_encrypt(), IDEA_cfb64_encrypt(), IDEA_ecb_encrypt(),
1790 IDEA_ofb64_encrypt()
1792 See L</Deprecated low-level encryption functions>.
1793 IDEA has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1799 There is no replacement. This function returned a constant string.
1803 MD2(), MD2_Init(), MD2_Update(), MD2_Final()
1805 See L</Deprecated low-level encryption functions>.
1806 MD2 has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1812 There is no replacement. This function returned a constant string.
1816 MD4(), MD4_Init(), MD4_Update(), MD4_Final(), MD4_Transform()
1818 See L</Deprecated low-level encryption functions>.
1819 MD4 has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1823 MDC2(), MDC2_Init(), MDC2_Update(), MDC2_Final()
1825 See L</Deprecated low-level encryption functions>.
1826 MDC2 has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1830 MD5(), MD5_Init(), MD5_Update(), MD5_Final(), MD5_Transform()
1832 See L</Deprecated low-level encryption functions>.
1838 This undocumented function has no replacement.
1839 See L<config(5)/HISTORY> for more details.
1845 Use L<OSSL_HTTP_parse_url(3)> instead.
1849 B<OCSP_REQ_CTX> type and B<OCSP_REQ_CTX_*()> functions
1851 These methods were used to collect all necessary data to form a HTTP request,
1852 and to perform the HTTP transfer with that request. With OpenSSL 3.0, the
1853 type is B<OSSL_HTTP_REQ_CTX>, and the deprecated functions are replaced
1854 with B<OSSL_HTTP_REQ_CTX_*()>. See L<OSSL_HTTP_REQ_CTX(3)> for additional
1859 OPENSSL_fork_child(), OPENSSL_fork_parent(), OPENSSL_fork_prepare()
1861 There is no replacement for these functions. These pthread fork support methods
1862 were unused by OpenSSL.
1866 OSSL_STORE_ctrl(), OSSL_STORE_do_all_loaders(), OSSL_STORE_LOADER_get0_engine(),
1867 OSSL_STORE_LOADER_get0_scheme(), OSSL_STORE_LOADER_new(),
1868 OSSL_STORE_LOADER_set_attach(), OSSL_STORE_LOADER_set_close(),
1869 OSSL_STORE_LOADER_set_ctrl(), OSSL_STORE_LOADER_set_eof(),
1870 OSSL_STORE_LOADER_set_error(), OSSL_STORE_LOADER_set_expect(),
1871 OSSL_STORE_LOADER_set_find(), OSSL_STORE_LOADER_set_load(),
1872 OSSL_STORE_LOADER_set_open(), OSSL_STORE_LOADER_set_open_ex(),
1873 OSSL_STORE_register_loader(), OSSL_STORE_unregister_loader(),
1876 These functions helped applications and engines create loaders for
1877 schemes they supported. These are all deprecated and discouraged in favour of
1878 provider implementations, see L<provider-storemgmt(7)>.
1882 PEM_read_DHparams(), PEM_read_bio_DHparams(),
1883 PEM_read_DSAparams(), PEM_read_bio_DSAparams(),
1884 PEM_read_DSAPrivateKey(), PEM_read_DSA_PUBKEY(),
1885 PEM_read_bio_DSAPrivateKey and PEM_read_bio_DSA_PUBKEY(),
1886 PEM_read_ECPKParameters(), PEM_read_ECPrivateKey(), PEM_read_EC_PUBKEY(),
1887 PEM_read_bio_ECPKParameters(), PEM_read_bio_ECPrivateKey(), PEM_read_bio_EC_PUBKEY(),
1888 PEM_read_RSAPrivateKey(), PEM_read_RSA_PUBKEY(), PEM_read_RSAPublicKey(),
1889 PEM_read_bio_RSAPrivateKey(), PEM_read_bio_RSA_PUBKEY(), PEM_read_bio_RSAPublicKey(),
1890 PEM_write_bio_DHparams(), PEM_write_bio_DHxparams(), PEM_write_DHparams(), PEM_write_DHxparams(),
1891 PEM_write_DSAparams(), PEM_write_DSAPrivateKey(), PEM_write_DSA_PUBKEY(),
1892 PEM_write_bio_DSAparams(), PEM_write_bio_DSAPrivateKey(), PEM_write_bio_DSA_PUBKEY(),
1893 PEM_write_ECPKParameters(), PEM_write_ECPrivateKey(), PEM_write_EC_PUBKEY(),
1894 PEM_write_bio_ECPKParameters(), PEM_write_bio_ECPrivateKey(), PEM_write_bio_EC_PUBKEY(),
1895 PEM_write_RSAPrivateKey(), PEM_write_RSA_PUBKEY(), PEM_write_RSAPublicKey(),
1896 PEM_write_bio_RSAPrivateKey(), PEM_write_bio_RSA_PUBKEY(),
1897 PEM_write_bio_RSAPublicKey(),
1899 See L</Deprecated low-level key reading and writing functions>
1905 See L</Deprecated low-level encryption functions>.
1909 RAND_get_rand_method(), RAND_set_rand_method(), RAND_OpenSSL(),
1910 RAND_set_rand_engine()
1912 Applications should instead use L<RAND_set_DRBG_type(3)>,
1913 L<EVP_RAND(3)> and L<EVP_RAND(7)>.
1914 See L<RAND_set_rand_method(3)> for more details.
1918 RC2_encrypt(), RC2_decrypt(), RC2_set_key(), RC2_cbc_encrypt(), RC2_cfb64_encrypt(),
1919 RC2_ecb_encrypt(), RC2_ofb64_encrypt(),
1920 RC4(), RC4_set_key(), RC4_options(),
1921 RC5_32_encrypt(), RC5_32_set_key(), RC5_32_decrypt(), RC5_32_cbc_encrypt(),
1922 RC5_32_cfb64_encrypt(), RC5_32_ecb_encrypt(), RC5_32_ofb64_encrypt()
1924 See L</Deprecated low-level encryption functions>.
1925 The Algorithms "RC2", "RC4" and "RC5" have been moved to the L<Legacy Provider|/Legacy Algorithms>.
1929 RIPEMD160(), RIPEMD160_Init(), RIPEMD160_Update(), RIPEMD160_Final(),
1930 RIPEMD160_Transform()
1932 See L</Deprecated low-level digest functions>.
1933 The RIPE algorithm has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1937 RSA_bits(), RSA_security_bits(), RSA_size()
1939 Use L<EVP_PKEY_get_bits(3)>, L<EVP_PKEY_get_security_bits(3)> and
1940 L<EVP_PKEY_get_size(3)>.
1944 RSA_check_key(), RSA_check_key_ex()
1946 See L</Deprecated low-level validation functions>
1950 RSA_clear_flags(), RSA_flags(), RSA_set_flags(), RSA_test_flags(),
1951 RSA_setup_blinding(), RSA_blinding_off(), RSA_blinding_on()
1953 All of these RSA flags have been deprecated without replacement:
1955 B<RSA_FLAG_BLINDING>, B<RSA_FLAG_CACHE_PRIVATE>, B<RSA_FLAG_CACHE_PUBLIC>,
1956 B<RSA_FLAG_EXT_PKEY>, B<RSA_FLAG_NO_BLINDING>, B<RSA_FLAG_THREAD_SAFE>
1957 B<RSA_METHOD_FLAG_NO_CHECK>
1961 RSA_generate_key_ex(), RSA_generate_multi_prime_key()
1963 See L</Deprecated low-level key generation functions>.
1969 See L</Providers are a replacement for engines and low-level method overrides>
1973 RSA_get0_crt_params(), RSA_get0_d(), RSA_get0_dmp1(), RSA_get0_dmq1(),
1974 RSA_get0_e(), RSA_get0_factors(), RSA_get0_iqmp(), RSA_get0_key(),
1975 RSA_get0_multi_prime_crt_params(), RSA_get0_multi_prime_factors(), RSA_get0_n(),
1976 RSA_get0_p(), RSA_get0_pss_params(), RSA_get0_q(),
1977 RSA_get_multi_prime_extra_count()
1979 See L</Deprecated low-level key parameter getters>
1983 RSA_new(), RSA_free(), RSA_up_ref()
1985 See L</Deprecated low-level object creation>.
1989 RSA_get_default_method(), RSA_get_ex_data and RSA_get_method()
1991 See L</Providers are a replacement for engines and low-level method overrides>.
1997 There is no replacement.
2001 B<RSA_meth_*()>, RSA_new_method(), RSA_null_method and RSA_PKCS1_OpenSSL()
2003 See L</Providers are a replacement for engines and low-level method overrides>.
2007 B<RSA_padding_add_*()>, B<RSA_padding_check_*()>
2009 See L</Deprecated low-level signing functions> and
2010 L</Deprecated low-level encryption functions>.
2014 RSA_print(), RSA_print_fp()
2016 See L</Deprecated low-level key printing functions>
2020 RSA_public_encrypt(), RSA_private_decrypt()
2022 See L</Deprecated low-level encryption functions>
2026 RSA_private_encrypt(), RSA_public_decrypt()
2028 This is equivalent to doing sign and verify operations (with a padding mode
2029 of none). See L</Deprecated low-level signing functions>.
2033 RSAPrivateKey_dup(), RSAPublicKey_dup()
2035 There is no direct replacement. Applications may use L<EVP_PKEY_dup(3)>.
2039 RSAPublicKey_it(), RSAPrivateKey_it()
2041 See L</Deprecated low-level key reading and writing functions>
2045 RSA_set0_crt_params(), RSA_set0_factors(), RSA_set0_key(),
2046 RSA_set0_multi_prime_params()
2048 See L</Deprecated low-level key parameter setters>.
2052 RSA_set_default_method(), RSA_set_method(), RSA_set_ex_data()
2054 See L</Providers are a replacement for engines and low-level method overrides>
2058 RSA_sign(), RSA_sign_ASN1_OCTET_STRING(), RSA_verify(),
2059 RSA_verify_ASN1_OCTET_STRING(), RSA_verify_PKCS1_PSS(),
2060 RSA_verify_PKCS1_PSS_mgf1()
2062 See L</Deprecated low-level signing functions>.
2066 RSA_X931_derive_ex(), RSA_X931_generate_key_ex(), RSA_X931_hash_id()
2068 There are no replacements for these functions.
2069 X931 padding can be set using L<EVP_SIGNATURE-RSA(7)/Signature Parameters>.
2070 See B<OSSL_SIGNATURE_PARAM_PAD_MODE>.
2074 SEED_encrypt(), SEED_decrypt(), SEED_set_key(), SEED_cbc_encrypt(),
2075 SEED_cfb128_encrypt(), SEED_ecb_encrypt(), SEED_ofb128_encrypt()
2077 See L</Deprecated low-level encryption functions>.
2078 The SEED algorithm has been moved to the L<Legacy Provider|/Legacy Algorithms>.
2082 SHA1_Init(), SHA1_Update(), SHA1_Final(), SHA1_Transform(),
2083 SHA224_Init(), SHA224_Update(), SHA224_Final(),
2084 SHA256_Init(), SHA256_Update(), SHA256_Final(), SHA256_Transform(),
2085 SHA384_Init(), SHA384_Update(), SHA384_Final(),
2086 SHA512_Init(), SHA512_Update(), SHA512_Final(), SHA512_Transform()
2088 See L</Deprecated low-level digest functions>.
2092 SRP_Calc_A(), SRP_Calc_B(), SRP_Calc_client_key(), SRP_Calc_server_key(),
2093 SRP_Calc_u(), SRP_Calc_x(), SRP_check_known_gN_param(), SRP_create_verifier(),
2094 SRP_create_verifier_BN(), SRP_get_default_gN(), SRP_user_pwd_free(), SRP_user_pwd_new(),
2095 SRP_user_pwd_set0_sv(), SRP_user_pwd_set1_ids(), SRP_user_pwd_set_gN(),
2096 SRP_VBASE_add0_user(), SRP_VBASE_free(), SRP_VBASE_get1_by_user(), SRP_VBASE_init(),
2097 SRP_VBASE_new(), SRP_Verify_A_mod_N(), SRP_Verify_B_mod_N()
2099 There are no replacements for the SRP functions.
2103 SSL_CTX_set_tmp_dh_callback(), SSL_set_tmp_dh_callback(),
2104 SSL_CTX_set_tmp_dh(), SSL_set_tmp_dh()
2106 These are used to set the Diffie-Hellman (DH) parameters that are to be used by
2107 servers requiring ephemeral DH keys. Instead applications should consider using
2108 the built-in DH parameters that are available by calling L<SSL_CTX_set_dh_auto(3)>
2109 or L<SSL_set_dh_auto(3)>. If custom parameters are necessary then applications can
2110 use the alternative functions L<SSL_CTX_set0_tmp_dh_pkey(3)> and
2111 L<SSL_set0_tmp_dh_pkey(3)>. There is no direct replacement for the "callback"
2112 functions. The callback was originally useful in order to have different
2113 parameters for export and non-export ciphersuites. Export ciphersuites are no
2114 longer supported by OpenSSL. Use of the callback functions should be replaced
2115 by one of the other methods described above.
2119 SSL_CTX_set_tlsext_ticket_key_cb()
2121 Use the new L<SSL_CTX_set_tlsext_ticket_key_evp_cb(3)> function instead.
2125 WHIRLPOOL(), WHIRLPOOL_Init(), WHIRLPOOL_Update(), WHIRLPOOL_Final(),
2126 WHIRLPOOL_BitUpdate()
2128 See L</Deprecated low-level digest functions>.
2129 The Whirlpool algorithm has been moved to the L<Legacy Provider|/Legacy Algorithms>.
2133 X509_certificate_type()
2135 This was an undocumented function. Applications can use L<X509_get0_pubkey(3)>
2136 and L<X509_get0_signature(3)> instead.
2140 X509_http_nbio(), X509_CRL_http_nbio()
2142 Use L<X509_load_http(3)> and L<X509_CRL_load_http(3)> instead.
2146 =head2 Using the FIPS Module in applications
2148 See L<fips_module(7)> and L<OSSL_PROVIDER-FIPS(7)> for details.
2150 =head2 OpenSSL command line application changes
2152 =head3 New applications
2154 L<B<openssl kdf>|openssl-kdf(1)> uses the new L<EVP_KDF(3)> API.
2155 L<B<openssl kdf>|openssl-mac(1)> uses the new L<EVP_MAC(3)> API.
2157 =head3 Added options
2159 B<-provider_path> and B<-provider> are available to all apps and can be used
2160 multiple times to load any providers, such as the 'legacy' provider or third
2161 party providers. If used then the 'default' provider would also need to be
2162 specified if required. The B<-provider_path> must be specified before the
2163 B<-provider> option.
2165 The B<list> app has many new options. See L<openssl-list(1)> for more
2168 B<-crl_lastupdate> and B<-crl_nextupdate> used by B<openssl ca> allows
2169 explicit setting of fields in the generated CRL.
2171 =head3 Removed options
2173 Interactive mode is not longer available.
2175 The B<-crypt> option used by B<openssl passwd>.
2176 The B<-c> option used by B<openssl x509>, B<openssl dhparam>,
2177 B<openssl dsaparam>, and B<openssl ecparam>.
2179 =head3 Other Changes
2181 The output of Command line applications may have minor changes.
2182 These are primarily changes in capitalisation and white space. However, in some
2183 cases, there are additional differences.
2184 For example, the DH parameters output from B<openssl dhparam> now lists 'P',
2185 'Q', 'G' and 'pcounter' instead of 'prime', 'generator', 'subgroup order' and
2186 'counter' respectively.
2188 The B<openssl> commands that read keys, certificates, and CRLs now
2189 automatically detect the PEM or DER format of the input files so it is not
2190 necessary to explicitly specify the input format anymore. However if the
2191 input format option is used the specified format will be required.
2193 B<openssl speed> no longer uses low-level API calls.
2194 This implies some of the performance numbers might not be comparable with the
2195 previous releases due to higher overhead. This applies particularly to
2196 measuring performance on smaller data chunks.
2198 b<openssl dhparam>, B<openssl dsa>, B<openssl gendsa>, B<openssl dsaparam>,
2199 B<openssl genrsa> and B<openssl rsa> have been modified to use PKEY APIs.
2200 B<openssl genrsa> and B<openssl rsa> now write PKCS #8 keys by default.
2202 =head3 Default settings
2204 "SHA256" is now the default digest for TS query used by B<openssl ts>.
2206 =head3 Deprecated apps
2208 B<openssl rsautl> is deprecated, use B<openssl pkeyutl> instead.
2209 B<openssl dhparam>, B<openssl dsa>, B<openssl gendsa>, B<openssl dsaparam>,
2210 B<openssl genrsa>, B<openssl rsa>, B<openssl genrsa> and B<openssl rsa> are
2211 now in maintenance mode and no new features will be added to them.
2219 TLS 1.3 FFDHE key exchange support added
2221 This uses DH safe prime named groups.
2225 Support for fully "pluggable" TLSv1.3 groups.
2227 This means that providers may supply their own group implementations (using
2228 either the "key exchange" or the "key encapsulation" methods) which will
2229 automatically be detected and used by libssl.
2233 SSL and SSL_CTX options are now 64 bit instead of 32 bit.
2235 The signatures of the functions to get and set options on SSL and
2236 SSL_CTX objects changed from "unsigned long" to "uint64_t" type.
2238 This may require source code changes.
2240 See L<SSL_CTX_get_options(3)>, L<SSL_CTX_set_options(3)>,
2241 L<SSL_get_options(3)> and L<SSL_set_options(3)>.
2245 SSL_set1_host() and SSL_add1_host() Changes
2247 These functions now take IP literal addresses as well as actual hostnames.
2251 Added SSL option SSL_OP_CLEANSE_PLAINTEXT
2253 If the option is set, openssl cleanses (zeroizes) plaintext bytes from
2254 internal buffers after delivering them to the application. Note,
2255 the application is still responsible for cleansing other copies
2256 (e.g.: data received by L<SSL_read(3)>).
2260 Client-initiated renegotiation is disabled by default.
2262 To allow it, use the B<-client_renegotiation> option,
2263 the B<SSL_OP_ALLOW_CLIENT_RENEGOTIATION> flag, or the C<ClientRenegotiation>
2264 config parameter as appropriate.
2268 Secure renegotiation is now required by default for TLS connections
2270 Support for RFC 5746 secure renegotiation is now required by default for
2271 SSL or TLS connections to succeed. Applications that require the ability
2272 to connect to legacy peers will need to explicitly set
2273 SSL_OP_LEGACY_SERVER_CONNECT. Accordingly, SSL_OP_LEGACY_SERVER_CONNECT
2274 is no longer set as part of SSL_OP_ALL.
2278 Combining the Configure options no-ec and no-dh no longer disables TLSv1.3
2280 Typically if OpenSSL has no EC or DH algorithms then it cannot support
2281 connections with TLSv1.3. However OpenSSL now supports "pluggable" groups
2282 through providers. Therefore third party providers may supply group
2283 implementations even where there are no built-in ones. Attempting to create
2284 TLS connections in such a build without also disabling TLSv1.3 at run time or
2285 using third party provider groups may result in handshake failures. TLSv1.3
2286 can be disabled at compile time using the "no-tls1_3" Configure option.
2290 SSL_CTX_set_ciphersuites() and SSL_set_ciphersuites() changes.
2292 The methods now ignore unknown ciphers.
2296 Security callback change.
2298 The security callback, which can be customised by application code, supports
2299 the security operation SSL_SECOP_TMP_DH. This is defined to take an EVP_PKEY
2300 in the "other" parameter. In most places this is what is passed. All these
2301 places occur server side. However there was one client side call of this
2302 security operation and it passed a DH object instead. This is incorrect
2303 according to the definition of SSL_SECOP_TMP_DH, and is inconsistent with all
2304 of the other locations. Therefore this client side call has been changed to
2305 pass an EVP_PKEY instead.
2309 New SSL option SSL_OP_IGNORE_UNEXPECTED_EOF
2311 The SSL option SSL_OP_IGNORE_UNEXPECTED_EOF is introduced. If that option
2312 is set, an unexpected EOF is ignored, it pretends a close notify was received
2313 instead and so the returned error becomes SSL_ERROR_ZERO_RETURN.
2317 The security strength of SHA1 and MD5 based signatures in TLS has been reduced.
2319 This results in SSL 3, TLS 1.0, TLS 1.1 and DTLS 1.0 no longer
2320 working at the default security level of 1 and instead requires security
2321 level 0. The security level can be changed either using the cipher string
2322 with `C<@SECLEVEL>, or calling L<SSL_CTX_set_security_level(3)>. This also means
2323 that where the signature algorithms extension is missing from a ClientHello
2324 then the handshake will fail in TLS 1.2 at security level 1. This is because,
2325 although this extension is optional, failing to provide one means that
2326 OpenSSL will fallback to a default set of signature algorithms. This default
2327 set requires the availability of SHA1.
2331 X509 certificates signed using SHA1 are no longer allowed at security level 1 and above.
2333 In TLS/SSL the default security level is 1. It can be set either using the cipher
2334 string with C<@SECLEVEL>, or calling L<SSL_CTX_set_security_level(3)>. If the
2335 leaf certificate is signed with SHA-1, a call to L<SSL_CTX_use_certificate(3)>
2336 will fail if the security level is not lowered first.
2337 Outside TLS/SSL, the default security level is -1 (effectively 0). It can
2338 be set using L<X509_VERIFY_PARAM_set_auth_level(3)> or using the B<-auth_level>
2339 options of the commands.
2349 Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
2351 Licensed under the Apache License 2.0 (the "License"). You may not use
2352 this file except in compliance with the License. You can obtain a copy
2353 in the file LICENSE in the source distribution or at
2354 L<https://www.openssl.org/source/license.html>.