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".
222 AES CTS cipher added to EVP layer.
224 The algorithms are "AES-128-CBC-CTS", "AES-192-CBC-CTS" and "AES-256-CBC-CTS".
225 CS1, CS2 and CS3 variants are supported.
229 =head4 CMS and PKCS#7 updates
235 Added CAdES-BES signature verification support.
239 Added CAdES-BES signature scheme and attributes support (RFC 5126) to CMS API.
243 Added AuthEnvelopedData content type structure (RFC 5083) using AES_GCM
245 This uses the AES-GCM parameter (RFC 5084) for the Cryptographic Message Syntax.
246 Its purpose is to support encryption and decryption of a digital envelope that
247 is both authenticated and encrypted using AES GCM mode.
251 L<PKCS7_get_octet_string(3)> and L<PKCS7_type_is_other(3)> were made public.
255 =head4 PKCS#12 API updates
257 The default algorithms for pkcs12 creation with the PKCS12_create() function
258 were changed to more modern PBKDF2 and AES based algorithms. The default
259 MAC iteration count was changed to PKCS12_DEFAULT_ITER to make it equal
260 with the password-based encryption iteration count. The default digest
261 algorithm for the MAC computation was changed to SHA-256. The pkcs12
262 application now supports -legacy option that restores the previous
263 default algorithms to support interoperability with legacy systems.
265 Added enhanced PKCS#12 APIs which accept a library context B<OSSL_LIB_CTX>
266 and (where relevant) a property query. Other APIs which handle PKCS#7 and
267 PKCS#8 objects have also been enhanced where required. This includes:
269 L<PKCS12_add_key_ex(3)>, L<PKCS12_add_safe_ex(3)>, L<PKCS12_add_safes_ex(3)>,
270 L<PKCS12_create_ex(3)>, L<PKCS12_decrypt_skey_ex(3)>, L<PKCS12_init_ex(3)>,
271 L<PKCS12_item_decrypt_d2i_ex(3)>, L<PKCS12_item_i2d_encrypt_ex(3)>,
272 L<PKCS12_key_gen_asc_ex(3)>, L<PKCS12_key_gen_uni_ex(3)>, L<PKCS12_key_gen_utf8_ex(3)>,
273 L<PKCS12_pack_p7encdata_ex(3)>, L<PKCS12_pbe_crypt_ex(3)>, L<PKCS12_PBE_keyivgen_ex(3)>,
274 L<PKCS12_SAFEBAG_create_pkcs8_encrypt_ex(3)>, L<PKCS5_pbe2_set_iv_ex(3)>,
275 L<PKCS5_pbe_set0_algor_ex(3)>, L<PKCS5_pbe_set_ex(3)>, L<PKCS5_pbkdf2_set_ex(3)>,
276 L<PKCS5_v2_PBE_keyivgen_ex(3)>, L<PKCS5_v2_scrypt_keyivgen_ex(3)>,
277 L<PKCS8_decrypt_ex(3)>, L<PKCS8_encrypt_ex(3)>, L<PKCS8_set0_pbe_ex(3)>.
279 As part of this change the EVP_PBE_xxx APIs can also accept a library
280 context and property query and will call an extended version of the key/IV
281 derivation function which supports these parameters. This includes
282 L<EVP_PBE_CipherInit_ex(3)>, L<EVP_PBE_find_ex(3)> and L<EVP_PBE_scrypt_ex(3)>.
284 =head4 Windows thread synchronization changes
286 Windows thread synchronization uses read/write primitives (SRWLock) when
287 supported by the OS, otherwise CriticalSection continues to be used.
291 A new generic trace API has been added which provides support for enabling
292 instrumentation through trace output. This feature is mainly intended as an aid
293 for developers and is disabled by default. To utilize it, OpenSSL needs to be
294 configured with the C<enable-trace> option.
296 If the tracing API is enabled, the application can activate trace output by
297 registering BIOs as trace channels for a number of tracing and debugging
298 categories. See L<OSSL_trace_enabled(3)>.
300 =head4 Key validation updates
302 L<EVP_PKEY_public_check(3)> and L<EVP_PKEY_param_check(3)> now work for
303 more key types. This includes RSA, DSA, ED25519, X25519, ED448 and X448.
304 Previously (in 1.1.1) they would return -2. For key types that do not have
305 parameters then L<EVP_PKEY_param_check(3)> will always return 1.
307 =head3 Other notable deprecations and changes
309 =head4 The function code part of an OpenSSL error code is no longer relevant
311 This code is now always set to zero. Related functions are deprecated.
313 =head4 STACK and HASH macros have been cleaned up
315 The type-safe wrappers are declared everywhere and implemented once.
316 See L<DEFINE_STACK_OF(3)> and L<DECLARE_LHASH_OF(3)>.
318 =head4 The RAND_DRBG subsystem has been removed
320 The new L<EVP_RAND(3)> is a partial replacement: the DRBG callback framework is
321 absent. The RAND_DRBG API did not fit well into the new provider concept as
322 implemented by EVP_RAND and EVP_RAND_CTX.
324 =head4 Removed FIPS_mode() and FIPS_mode_set()
326 These functions are legacy APIs that are not applicable to the new provider
327 model. Applications should instead use
328 L<EVP_default_properties_is_fips_enabled(3)> and
329 L<EVP_default_properties_enable_fips(3)>.
331 =head4 Key generation is slower
333 The Miller-Rabin test now uses 64 rounds, which is used for all prime generation,
334 including RSA key generation. This affects the time for larger keys sizes.
336 The default key generation method for the regular 2-prime RSA keys was changed
337 to the FIPS 186-4 B.3.6 method (Generation of Probable Primes with Conditions
338 Based on Auxiliary Probable Primes). This method is slower than the original
341 =head4 Change PBKDF2 to conform to SP800-132 instead of the older PKCS5 RFC2898
343 This checks that the salt length is at least 128 bits, the derived key length is
344 at least 112 bits, and that the iteration count is at least 1000.
345 For backwards compatibility these checks are disabled by default in the
346 default provider, but are enabled by default in the fips provider.
348 To enable or disable the checks see B<OSSL_KDF_PARAM_PKCS5> in
349 L<EVP_KDF-PBKDF2(7)>. The parameter can be set using L<EVP_KDF_derive(3)>.
351 =head4 Enforce a minimum DH modulus size of 512 bits
353 Smaller sizes now result in an error.
355 =head4 SM2 key changes
357 EC EVP_PKEYs with the SM2 curve have been reworked to automatically become
358 EVP_PKEY_SM2 rather than EVP_PKEY_EC.
360 Unlike in previous OpenSSL versions, this means that applications cannot
361 call C<EVP_PKEY_set_alias_type(pkey, EVP_PKEY_SM2)> to get SM2 computations.
363 Parameter and key generation is also reworked to make it possible
364 to generate EVP_PKEY_SM2 parameters and keys. Applications must now generate
365 SM2 keys directly and must not create an EVP_PKEY_EC key first. It is no longer
366 possible to import an SM2 key with domain parameters other than the SM2 elliptic
369 Validation of SM2 keys has been separated from the validation of regular EC
370 keys, allowing to improve the SM2 validation process to reject loaded private
371 keys that are not conforming to the SM2 ISO standard.
372 In particular, a private scalar `k` outside the range `1 <= k < n-1` is now
375 =head4 EVP_PKEY_set_alias_type() method has been removed
377 This function made a B<EVP_PKEY> object mutable after it had been set up. In
378 OpenSSL 3.0 it was decided that a provided key should not be able to change its
379 type, so this function has been removed.
381 =head4 Functions that return an internal key should be treated as read only
383 Functions such as L<EVP_PKEY_get0_RSA(3)> behave slightly differently in
384 OpenSSL 3.0. Previously they returned a pointer to the low-level key used
385 internally by libcrypto. From OpenSSL 3.0 this key may now be held in a
386 provider. Calling these functions will only return a handle on the internal key
387 where the EVP_PKEY was constructed using this key in the first place, for
388 example using a function or macro such as L<EVP_PKEY_assign_RSA(3)>,
389 L<EVP_PKEY_set1_RSA(3)>, etc.
390 Where the EVP_PKEY holds a provider managed key, then these functions now return
391 a cached copy of the key. Changes to the internal provider key that take place
392 after the first time the cached key is accessed will not be reflected back in
393 the cached copy. Similarly any changes made to the cached copy by application
394 code will not be reflected back in the internal provider key.
396 For the above reasons the keys returned from these functions should typically be
397 treated as read-only. To emphasise this the value returned from
398 L<EVP_PKEY_get0_RSA(3)>, L<EVP_PKEY_get0_DSA(3)>, L<EVP_PKEY_get0_EC_KEY(3)> and
399 L<EVP_PKEY_get0_DH(3)> have been made const. This may break some existing code.
400 Applications broken by this change should be modified. The preferred solution is
401 to refactor the code to avoid the use of these deprecated functions. Failing
402 this the code should be modified to use a const pointer instead.
403 The L<EVP_PKEY_get1_RSA(3)>, L<EVP_PKEY_get1_DSA(3)>, L<EVP_PKEY_get1_EC_KEY(3)>
404 and L<EVP_PKEY_get1_DH(3)> functions continue to return a non-const pointer to
405 enable them to be "freed". However they should also be treated as read-only.
407 =head4 The public key check has moved from EVP_PKEY_derive() to EVP_PKEY_derive_set_peer()
409 This may mean result in an error in L<EVP_PKEY_derive_set_peer(3)> rather than
410 during L<EVP_PKEY_derive(3)>.
411 To disable this check use EVP_PKEY_derive_set_peer_ex(dh, peer, 0).
413 =head4 The print format has cosmetic changes for some functions
415 The output from numerous "printing" functions such as L<X509_signature_print(3)>,
416 L<X509_print_ex(3)>, L<X509_CRL_print_ex(3)>, and other similar functions has been
417 amended such that there may be cosmetic differences between the output
418 observed in 1.1.1 and 3.0. This also applies to the B<-text> output from the
419 B<openssl x509> and B<openssl crl> applications.
421 =head4 Interactive mode from the B<openssl> program has been removed
423 From now on, running it without arguments is equivalent to B<openssl help>.
425 =head4 The error return values from some control calls (ctrl) have changed
427 One significant change is that controls which used to return -2 for
428 invalid inputs, now return -1 indicating a generic error condition instead.
430 =head4 DH and DHX key types have different settable parameters
432 Previously (in 1.1.1) these conflicting parameters were allowed, but will now
433 result in errors. See L<EVP_PKEY-DH(7)> for further details. This affects the
434 behaviour of L<openssl-genpkey(1)> for DH parameter generation.
436 =head4 EVP_CIPHER_CTX_set_flags() ordering change
438 If using a cipher from a provider the B<EVP_CIPH_FLAG_LENGTH_BITS> flag can only
439 be set B<after> the cipher has been assigned to the cipher context.
440 See L<EVP_EncryptInit(3)/FLAGS> for more information.
442 =head2 Installation and Compilation
444 Please refer to the INSTALL.md file in the top of the distribution for
445 instructions on how to build and install OpenSSL 3.0. Please also refer to the
446 various platform specific NOTES files for your specific platform.
448 =head2 Upgrading from OpenSSL 1.1.1
450 Upgrading to OpenSSL 3.0 from OpenSSL 1.1.1 should be relatively straight
451 forward in most cases. The most likely area where you will encounter problems
452 is if you have used low level APIs in your code (as discussed above). In that
453 case you are likely to start seeing deprecation warnings when compiling your
454 application. If this happens you have 3 options:
460 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.
464 Suppress the warnings. Refer to your compiler documentation on how to do this.
468 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
472 =head2 Upgrading from OpenSSL 1.0.2
474 Upgrading to OpenSSL 3.0 from OpenSSL 1.0.2 is likely to be significantly more
475 difficult. In addition to the issues discussed above in the section about
476 L</Upgrading from OpenSSL 1.1.1>, the main things to be aware of are:
482 The build and installation procedure has changed significantly.
484 Check the file INSTALL.md in the top of the installation for instructions on how
485 to build and install OpenSSL for your platform. Also read the various NOTES
486 files in the same directory, as applicable for your platform.
490 Many structures have been made opaque in OpenSSL 3.0.
492 The structure definitions have been removed from the public header files and
493 moved to internal header files. In practice this means that you can no longer
494 stack allocate some structures. Instead they must be heap allocated through some
495 function call (typically those function names have a C<_new> suffix to them).
496 Additionally you must use "setter" or "getter" functions to access the fields
497 within those structures.
499 For example code that previously looked like this:
503 /* This line will now generate compiler errors */
504 EVP_MD_CTX_init(&md_ctx);
506 The code needs to be amended to look like this:
510 md_ctx = EVP_MD_CTX_new();
513 EVP_MD_CTX_free(md_ctx);
517 Support for TLSv1.3 has been added.
519 This has a number of implications for SSL/TLS applications. See the
520 L<TLS1.3 page|https://wiki.openssl.org/index.php/TLS1.3> for further details.
524 More details about the breaking changes between OpenSSL versions 1.0.2 and 1.1.0
526 L<OpenSSL 1.1.0 Changes page|https://wiki.openssl.org/index.php/OpenSSL_1.1.0_Changes>.
528 =head3 Upgrading from the OpenSSL 2.0 FIPS Object Module
530 The OpenSSL 2.0 FIPS Object Module was a separate download that had to be built
531 separately and then integrated into your main OpenSSL 1.0.2 build.
532 In OpenSSL 3.0 the FIPS support is fully integrated into the mainline version of
533 OpenSSL and is no longer a separate download. For further information see
534 L</Completing the installation of the FIPS Module>.
536 The function calls FIPS_mode() and FIPS_mode_set() have been removed
537 from OpenSSL 3.0. You should rewrite your application to not use them.
538 See L<fips_module(7)> and L<OSSL_PROVIDER-FIPS(7)> for details.
540 =head2 Completing the installation of the FIPS Module
542 The FIPS Module will be built and installed automatically if FIPS support has
543 been configured. The current documentation can be found in the
544 L<README-FIPS|https://github.com/openssl/openssl/blob/master/README-FIPS.md> file.
548 Applications written to work with OpenSSL 1.1.1 will mostly just work with
549 OpenSSL 3.0. However changes will be required if you want to take advantage of
550 some of the new features that OpenSSL 3.0 makes available. In order to do that
551 you need to understand some new concepts introduced in OpenSSL 3.0.
552 Read L<crypto(7)/Library contexts> for further information.
554 =head3 Library Context
556 A library context allows different components of a complex application to each
557 use a different library context and have different providers loaded with
558 different configuration settings.
559 See L<crypto(7)/Library contexts> for further info.
561 If the user creates an B<OSSL_LIB_CTX> via L<OSSL_LIB_CTX_new(3)> then many
562 functions may need to be changed to pass additional parameters to handle the
565 =head4 Using a Library Context - Old functions that should be changed
567 If a library context is needed then all EVP_* digest functions that return a
568 B<const EVP_MD *> such as EVP_sha256() should be replaced with a call to
569 L<EVP_MD_fetch(3)>. See L<crypto(7)/ALGORITHM FETCHING>.
571 If a library context is needed then all EVP_* cipher functions that return a
572 B<const EVP_CIPHER *> such as EVP_aes_128_cbc() should be replaced vith a call to
573 L<EVP_CIPHER_fetch(3)>. See L<crypto(7)/ALGORITHM FETCHING>.
575 Some functions can be passed an object that has already been set up with a library
576 context such as L<d2i_X509(3)>, L<d2i_X509_CRL(3)>, L<d2i_X509_REQ(3)> and
577 L<d2i_X509_PUBKEY(3)>. If NULL is passed instead then the created object will be
578 set up with the default library context. Use L<X509_new_ex(3)>,
579 L<X509_CRL_new_ex(3)>, L<X509_REQ_new_ex(3)> and L<X509_PUBKEY_new_ex(3)> if a
580 library context is required.
582 All functions listed below with a I<NAME> have a replacment function I<NAME_ex>
583 that takes B<OSSL_LIB_CTX> as an additional argument. Functions that have other
584 mappings are listed along with the respective name.
590 L<ASN1_item_new(3)>, L<ASN1_item_d2i(3)>, L<ASN1_item_d2i_fp(3)>,
591 L<ASN1_item_d2i_bio(3)>, L<ASN1_item_sign(3)> and L<ASN1_item_verify(3)>
599 b2i_RSA_PVK_bio() and i2b_PVK_bio()
603 L<BN_CTX_new(3)> and L<BN_CTX_secure_new(3)>
607 L<CMS_AuthEnvelopedData_create(3)>, L<CMS_ContentInfo_new(3)>, L<CMS_data_create(3)>,
608 L<CMS_digest_create(3)>, L<CMS_EncryptedData_encrypt(3)>, L<CMS_encrypt(3)>,
609 L<CMS_EnvelopedData_create(3)>, L<CMS_ReceiptRequest_create0(3)> and L<CMS_sign(3)>
613 L<CONF_modules_load_file(3)>
617 L<CTLOG_new(3)>, L<CTLOG_new_from_base64(3)> and L<CTLOG_STORE_new(3)>
621 L<CT_POLICY_EVAL_CTX_new(3)>
625 L<d2i_AutoPrivateKey(3)>, L<d2i_PrivateKey(3)> and L<d2i_PUBKEY(3)>
629 L<d2i_PrivateKey_bio(3)> and L<d2i_PrivateKey_fp(3)>
631 Use L<d2i_PrivateKey_ex_bio(3)> and L<d2i_PrivateKey_ex_fp(3)>
637 Use L<EC_GROUP_new_by_curve_name_ex(3)> or L<EC_GROUP_new_from_params(3)>.
641 L<EVP_DigestSignInit(3)> and L<EVP_DigestVerifyInit(3)>
645 L<EVP_PBE_CipherInit(3)>, L<EVP_PBE_find(3)> and L<EVP_PBE_scrypt(3)>
649 L<PKCS5_PBE_keyivgen(3)>
657 L<EVP_PKEY_CTX_new_id(3)>
659 Use L<EVP_PKEY_CTX_new_from_name(3)>
663 L<EVP_PKEY_derive_set_peer(3)>, L<EVP_PKEY_new_raw_private_key(3)>
664 and L<EVP_PKEY_new_raw_public_key(3)>
668 L<EVP_SignFinal(3)> and L<EVP_VerifyFinal(3)>
676 L<OCSP_RESPID_match(3)> and L<OCSP_RESPID_set_by_key(3)>
680 L<OPENSSL_thread_stop(3)>
684 L<OSSL_STORE_open(3)>
688 L<PEM_read_bio_Parameters(3)>, L<PEM_read_bio_PrivateKey(3)>, L<PEM_read_bio_PUBKEY(3)>,
689 L<PEM_read_PrivateKey(3)> and L<PEM_read_PUBKEY(3)>
693 L<PEM_write_bio_PrivateKey(3)>, L<PEM_write_bio_PUBKEY(3)>, L<PEM_write_PrivateKey(3)>
694 and L<PEM_write_PUBKEY(3)>
698 L<PEM_X509_INFO_read_bio(3)> and L<PEM_X509_INFO_read(3)>
702 L<PKCS12_add_key(3)>, L<PKCS12_add_safe(3)>, L<PKCS12_add_safes(3)>,
703 L<PKCS12_create(3)>, L<PKCS12_decrypt_skey(3)>, L<PKCS12_init(3)>, L<PKCS12_item_decrypt_d2i(3)>,
704 L<PKCS12_item_i2d_encrypt(3)>, L<PKCS12_key_gen_asc(3)>, L<PKCS12_key_gen_uni(3)>,
705 L<PKCS12_key_gen_utf8(3)>, L<PKCS12_pack_p7encdata(3)>, L<PKCS12_pbe_crypt(3)>,
706 L<PKCS12_PBE_keyivgen(3)>, L<PKCS12_SAFEBAG_create_pkcs8_encrypt(3)>
710 L<PKCS5_pbe_set0_algor(3)>, L<PKCS5_pbe_set(3)>, L<PKCS5_pbe2_set_iv(3)>,
711 L<PKCS5_pbkdf2_set(3)> and L<PKCS5_v2_scrypt_keyivgen(3)>
715 L<PKCS7_encrypt(3)>, L<PKCS7_new(3)> and L<PKCS7_sign(3)>
719 L<PKCS8_decrypt(3)>, L<PKCS8_encrypt(3)> and L<PKCS8_set0_pbe(3)>
723 L<RAND_bytes(3)> and L<RAND_priv_bytes(3)>
727 L<SMIME_write_ASN1(3)>
731 L<SSL_load_client_CA_file(3)>
739 L<TS_RESP_CTX_new(3)>
747 L<X509_load_cert_crl_file(3)> and L<X509_load_cert_file(3)>
751 L<X509_LOOKUP_by_subject(3)> and L<X509_LOOKUP_ctrl(3)>
763 L<X509_REQ_new(3)> and L<X509_REQ_verify(3)>
767 L<X509_STORE_CTX_new(3)>, L<X509_STORE_set_default_paths(3)>, L<X509_STORE_load_file(3)>,
768 L<X509_STORE_load_locations(3)> and L<X509_STORE_load_store(3)>
772 =head4 New functions that use a Library context
774 The following functions can be passed a library context if required.
775 Passing NULL will use the default library context.
781 L<BIO_new_from_core_bio(3)>
785 L<EVP_ASYM_CIPHER_fetch(3)> and L<EVP_ASYM_CIPHER_do_all_provided(3)>
789 L<EVP_CIPHER_fetch(3)> and L<EVP_CIPHER_do_all_provided(3)>
793 L<EVP_default_properties_enable_fips(3)> and
794 L<EVP_default_properties_is_fips_enabled(3)>
798 L<EVP_KDF_fetch(3)> and L<EVP_KDF_do_all_provided(3)>
802 L<EVP_KEM_fetch(3)> and L<EVP_KEM_do_all_provided(3)>
806 L<EVP_KEYEXCH_fetch(3)> and L<EVP_KEYEXCH_do_all_provided(3)>
810 L<EVP_KEYMGMT_fetch(3)> and L<EVP_KEYMGMT_do_all_provided(3)>
814 L<EVP_MAC_fetch(3)> and L<EVP_MAC_do_all_provided(3)>
818 L<EVP_MD_fetch(3)> and L<EVP_MD_do_all_provided(3)>
822 L<EVP_PKEY_CTX_new_from_pkey(3)>
826 L<EVP_PKEY_Q_keygen(3)>
830 L<EVP_Q_mac(3)> and L<EVP_Q_digest(3)>
834 L<EVP_RAND(3)> and L<EVP_RAND_do_all_provided(3)>
838 L<EVP_set_default_properties(3)>
842 L<EVP_SIGNATURE_fetch(3)> and L<EVP_SIGNATURE_do_all_provided(3)>
846 L<OSSL_CMP_CTX_new(3)> and L<OSSL_CMP_SRV_CTX_new(3)>
850 L<OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(3)>
854 L<OSSL_CRMF_MSG_create_popo(3)> and L<OSSL_CRMF_MSGS_verify_popo(3)>
858 L<OSSL_CRMF_pbm_new(3)> and L<OSSL_CRMF_pbmp_new(3)>
862 L<OSSL_DECODER_CTX_add_extra(3)> and L<OSSL_DECODER_CTX_new_for_pkey(3)>
866 L<OSSL_DECODER_fetch(3)> and L<OSSL_DECODER_do_all_provided(3)>
870 L<OSSL_ENCODER_CTX_add_extra(3)>
874 L<OSSL_ENCODER_fetch(3)> and L<OSSL_ENCODER_do_all_provided(3)>
878 L<OSSL_LIB_CTX_free(3)>, L<OSSL_LIB_CTX_load_config(3)> and L<OSSL_LIB_CTX_set0_default(3)>
882 L<OSSL_PROVIDER_add_builtin(3)>, L<OSSL_PROVIDER_available(3)>,
883 L<OSSL_PROVIDER_do_all(3)>, L<OSSL_PROVIDER_load(3)>,
884 L<OSSL_PROVIDER_set_default_search_path(3)> and L<OSSL_PROVIDER_try_load(3)>
888 L<OSSL_SELF_TEST_get_callback(3)> and L<OSSL_SELF_TEST_set_callback(3)>
892 L<OSSL_STORE_attach(3)>
896 L<OSSL_STORE_LOADER_fetch(3)> and L<OSSL_STORE_LOADER_do_all_provided(3)>
900 L<RAND_get0_primary(3)>, L<RAND_get0_private(3)>, L<RAND_get0_public(3)>,
901 L<RAND_set_DRBG_type(3)> and L<RAND_set_seed_source_type(3)>
907 Providers are described in detail here L<crypto(7)/Providers>.
908 See also L<crypto(7)/OPENSSL PROVIDERS>.
910 =head3 Fetching algorithms and property queries
912 Implicit and Explicit Fetching is described in detail here
913 L<crypto(7)/ALGORITHM FETCHING>.
915 =head3 Mapping EVP controls and flags to provider B<OSSL_PARAM> parameters
917 The existing functions for controls (such as L<EVP_CIPHER_CTX_ctrl(3)>) and
918 manipulating flags (such as L<EVP_MD_CTX_set_flags(3)>)internally use
919 B<OSSL_PARAMS> to pass information to/from provider objects.
920 See L<OSSL_PARAM(3)> for additional information related to parameters.
922 For ciphers see L<EVP_EncryptInit(3)/CONTROLS>, L<EVP_EncryptInit(3)/FLAGS> and
923 L<EVP_EncryptInit(3)/PARAMETERS>.
925 For digests see L<EVP_DigestInit(3)/CONTROLS>, L<EVP_DigestInit(3)/FLAGS> and
926 L<EVP_DigestInit(3)/PARAMETERS>.
928 =head3 Deprecation of Low Level Functions
930 A significant number of APIs have been deprecated in OpenSSL 3.0.
931 This section describes some common categories of deprecations.
932 See L</Deprecated function mappings> for the list of deprecated functions
933 that refer to these categories.
935 =head4 Providers are a replacement for engines and low-level method overrides
937 Any accessor that uses an ENGINE is deprecated (such as EVP_PKEY_set1_engine()).
938 Applications using engines should instead use providers.
940 Before providers were added algorithms were overriden by changing the methods
941 used by algorithms. All these methods such as RSA_new_method() and RSA_meth_new()
942 are now deprecated and can be replaced by using providers instead.
944 =head4 Deprecated i2d and d2i functions for low-level key types
946 Any i2d and d2i functions such as d2i_DHparams() that take a low-level key type
947 have been deprecated. Applications should instead use the L<OSSL_DECODER(3)> and
948 L<OSSL_ENCODER(3)> APIs to read and write files.
949 See L<d2i_RSAPrivateKey(3)/Migration> for further details.
951 =head4 Deprecated low-level key object getters and setters
953 Applications that set or get low-level key objects (such as EVP_PKEY_set1_DH()
954 or EVP_PKEY_get0()) should instead use the OSSL_ENCODER
955 (See L<OSSL_ENCODER_to_bio(3)>) or OSSL_DECODER (See L<OSSL_DECODER_from_bio(3)>)
956 APIs, or alternatively use L<EVP_PKEY_fromdata(3)> or L<EVP_PKEY_todata(3)>.
958 =head4 Deprecated low-level key parameter getters
960 Functions that access low-level objects directly such as L<RSA_get0_n(3)> are now
961 deprecated. Applications should use one of L<EVP_PKEY_get_bn_param(3)>,
962 L<EVP_PKEY_get_int_param(3)>, l<EVP_PKEY_get_size_t_param(3)>,
963 L<EVP_PKEY_get_utf8_string_param(3)>, L<EVP_PKEY_get_octet_string_param(3)> or
964 L<EVP_PKEY_get_params(3)> to access fields from an EVP_PKEY.
965 Gettable parameters are listed in L<EVP_PKEY-RSA(7)/Common RSA parameters>,
966 L<EVP_PKEY-DH(7)/DH parameters>, L<EVP_PKEY-DSA(7)/DSA parameters>,
967 L<EVP_PKEY-FFC(7)/FFC parameters>, L<EVP_PKEY-EC(7)/Common EC parameters> and
968 L<EVP_PKEY-X25519(7)/Common X25519, X448, ED25519 and ED448 parameters>.
969 Applications may also use L<EVP_PKEY_todata(3)> to return all fields.
971 =head4 Deprecated low-level key parameter setters
973 Functions that access low-level objects directly such as L<RSA_set0_crt_params(3)>
974 are now deprecated. Applications should use L<EVP_PKEY_fromdata(3)> to create
975 new keys from user provided key data. Keys should be immutable once they are
976 created, so if required the user may use L<EVP_PKEY_todata(3)>, L<OSSL_PARAM_merge(3)>,
977 and L<EVP_PKEY_fromdata(3)> to create a modified key.
978 See L<EVP_PKEY-DH(7)/Examples> for more information.
979 See L</Deprecated low-level key generation functions> for information on
980 generating a key using parameters.
982 =head4 Deprecated low-level object creation
984 Low-level objects were created using methods such as L<RSA_new(3)>,
985 L<RSA_up_ref(3)> and L<RSA_free(3)>. Applications should instead use the
986 high-level EVP_PKEY APIs, e.g. L<EVP_PKEY_new(3)>, L<EVP_PKEY_up_ref(3)> and
988 See also L<EVP_PKEY_CTX_new_from_name(3)> and L<EVP_PKEY_CTX_new_from_pkey(3)>.
990 EVP_PKEYs may be created in a variety of ways:
991 See also L</Deprecated low-level key generation functions>,
992 L</Deprecated low-level key reading and writing functions> and
993 L</Deprecated low-level key parameter setters>.
995 =head4 Deprecated low-level encryption functions
997 Low-level encryption functions such as L<AES_encrypt(3)> and L<AES_decrypt(3)>
998 have been informally discouraged from use for a long time. Applications should
999 instead use the high level EVP APIs L<EVP_EncryptInit_ex(3)>,
1000 L<EVP_EncryptUpdate(3)>, and L<EVP_EncryptFinal_ex(3)> or
1001 L<EVP_DecryptInit_ex(3)>, L<EVP_DecryptUpdate(3)> and L<EVP_DecryptFinal_ex(3)>.
1003 =head4 Deprecated low-level digest functions
1005 Use of low-level digest functions such as L<SHA1_Init(3)> have been
1006 informally discouraged from use for a long time. Applications should instead
1007 use the the high level EVP APIs L<EVP_DigestInit_ex(3)>, L<EVP_DigestUpdate(3)>
1008 and L<EVP_DigestFinal_ex(3)>, or the quick one-shot L<EVP_Q_digest(3)>.
1010 Note that the functions L<SHA1(3)>, L<SHA224(3)>, L<SHA256(3)>, L<SHA384(3)>
1011 and L<SHA512(3)> have changed to macros that use L<EVP_Q_digest(3)>.
1013 =head4 Deprecated low-level signing functions
1015 Use of low-level signing functions such as L<DSA_sign(3)> have been
1016 informally discouraged for a long time. Instead applications should use
1017 L<EVP_DigestSign(3)> and L<EVP_DigestVerify(3)>.
1018 See also L<EVP_SIGNATURE-RSA(7)>, L<EVP_SIGNATURE-DSA(7)>,
1019 L<EVP_SIGNATURE-ECDSA(7)> and L<EVP_SIGNATURE-ED25519(7)>.
1021 =head4 Deprecated low-level MAC functions
1023 Low-level mac functions such as L<CMAC_Init(3)> are deprecated.
1024 Applications should instead use the new L<EVP_MAC(3)> interface, using
1025 L<EVP_MAC_CTX_new(3)>, L<EVP_MAC_CTX_free(3)>, L<EVP_MAC_init(3)>,
1026 L<EVP_MAC_update(3)> and L<EVP_MAC_final(3)> or the single-shot MAC function
1028 See L<EVP_MAC(3)>, L<EVP_MAC-HMAC(7)>, L<EVP_MAC-CMAC(7)>, L<EVP_MAC-GMAC(7)>,
1029 L<EVP_MAC-KMAC(7)>, L<EVP_MAC-BLAKE2(7)>, L<EVP_MAC-Poly1305(7)> and
1030 L<EVP_MAC-Siphash(7)> for additional information.
1032 Note that the one-shot method HMAC() is still available for compatability purposes.
1034 =head4 Deprecated low-level validation functions
1036 Low-level validation functions such as L<DH_check(3)> have been informally
1037 discouraged from use for a long time. Applications should instead use the high-level
1038 EVP_PKEY APIs such as L<EVP_PKEY_check(3)>, L<EVP_PKEY_param_check(3)>,
1039 L<EVP_PKEY_param_check_quick(3)>, L<EVP_PKEY_public_check(3)>,
1040 L<EVP_PKEY_public_check_quick(3)>, L<EVP_PKEY_private_check(3)>,
1041 and L<EVP_PKEY_pairwise_check(3)>.
1043 =head4 Deprecated low-level key exchange functions
1045 Many low-level functions have been informally discouraged from use for a long
1046 time. Applications should instead use L<EVP_PKEY_derive(3)>.
1047 See L<EVP_KEYEXCH-DH(7)>, L<EVP_KEYEXCH-ECDH(7)> and L<EVP_KEYEXCH-X25519(7)>.
1049 =head4 Deprecated low-level key generation functions
1051 Many low-level functions have been informally discouraged from use for a long
1052 time. Applications should instead use L<EVP_PKEY_keygen_init(3)> and
1053 L<EVP_PKEY_generate(3)> as described in L<EVP_PKEY-DSA(7)>, L<EVP_PKEY-DH(7)>,
1054 L<EVP_PKEY-RSA(7)>, L<EVP_PKEY-EC(7)> and L<EVP_PKEY-X25519(7)>.
1055 The 'quick' one-shot function L<EVP_PKEY_Q_keygen(3)> and macros for the most
1056 common cases: <EVP_RSA_gen(3)> and L<EVP_EC_gen(3)> may also be used.
1058 =head4 Deprecated low-level key reading and writing functions
1060 Use of low-level objects (such as DSA) has been informally discouraged from use
1061 for a long time. Functions to read and write these low-level objects (such as
1062 PEM_read_DSA_PUBKEY()) should be replaced. Applications should instead use
1063 L<OSSL_ENCODER_to_bio(3)> and L<OSSL_DECODER_from_bio(3)>.
1065 =head4 Deprecated low-level key printing functions
1067 Use of low-level objects (such as DSA) has been informally discouraged from use
1068 for a long time. Functions to print these low-level objects such as
1069 DSA_print() should be replaced with the equivalent EVP_PKEY functions.
1070 Application should use one of L<EVP_PKEY_print_public(3)>,
1071 L<EVP_PKEY_print_private(3)>, L<EVP_PKEY_print_params(3)>,
1072 L<EVP_PKEY_print_public_fp(3)>, L<EVP_PKEY_print_private_fp(3)> or
1073 L<EVP_PKEY_print_params_fp(3)>. Note that internally these use
1074 L<OSSL_ENCODER_to_bio(3)> and L<OSSL_DECODER_from_bio(3)>.
1076 =head3 Deprecated function mappings
1078 The following functions have been deprecated in 3.0.
1084 AES_bi_ige_encrypt() and AES_ige_encrypt()
1086 There is no replacement for the IGE functions. New code should not use these modes.
1087 These undocumented functions were never integrated into the EVP layer.
1088 They implemented the AES Infinite Garble Extension (IGE) mode and AES
1089 Bi-directional IGE mode. These modes were never formally standardised and
1090 usage of these functions is believed to be very small. In particular
1091 AES_bi_ige_encrypt() has a known bug. It accepts 2 AES keys, but only one
1092 is ever used. The security implications are believed to be minimal, but
1093 this issue was never fixed for backwards compatibility reasons.
1097 AES_encrypt(), AES_decrypt(), AES_set_encrypt_key(), AES_set_decrypt_key(),
1098 AES_cbc_encrypt(), AES_cfb128_encrypt(), AES_cfb1_encrypt(), AES_cfb8_encrypt(),
1099 AES_ecb_encrypt(), AES_ofb128_encrypt()
1103 AES_unwrap_key(), AES_wrap_key()
1105 See L</Deprecated low-level encryption functions>
1111 There is no replacement. It returned a string indicating if the AES code was unrolled.
1115 ASN1_digest(), ASN1_sign(), ASN1_verify()
1117 There are no replacements. These old functions are not used, and could be
1118 disabled with the macro NO_ASN1_OLD since OpenSSL 0.9.7.
1122 ASN1_STRING_length_set()
1124 Use L<ASN1_STRING_set(3)> or L<ASN1_STRING_set0(3)> instead.
1125 This was a potentially unsafe function that could change the bounds of a
1126 previously passed in pointer.
1130 BF_encrypt(), BF_decrypt(), BF_set_key(), BF_cbc_encrypt(), BF_cfb64_encrypt(),
1131 BF_ecb_encrypt(), BF_ofb64_encrypt()
1133 See L</Deprecated low-level encryption functions>.
1134 The Blowfish algorithm has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1140 There is no replacement. This option returned a constant string.
1144 BIO_get_callback(), BIO_set_callback(), BIO_debug_callback()
1146 Use the respective non-deprecated _ex() functions.
1150 BN_is_prime_ex(), BN_is_prime_fasttest_ex()
1152 Use L<BN_check_prime(3)> which that avoids possible misuse and always uses at least
1153 64 rounds of the Miller-Rabin primality test.
1157 BN_pseudo_rand(), BN_pseudo_rand_range()
1159 Use L<BN_rand(3)> and L<BN_rand_range(3)>.
1163 BN_X931_derive_prime_ex(), BN_X931_generate_prime_ex(), BN_X931_generate_Xpq()
1165 There are no replacements for these low-level functions. They were used internally
1166 by RSA_X931_derive_ex() and RSA_X931_generate_key_ex() which are also deprecated.
1167 Use L<EVP_PKEY_keygen(3)> instead.
1171 Camellia_encrypt(), Camellia_decrypt(), Camellia_set_key(),
1172 Camellia_cbc_encrypt(), Camellia_cfb128_encrypt(), Camellia_cfb1_encrypt(),
1173 Camellia_cfb8_encrypt(), Camellia_ctr128_encrypt(), Camellia_ecb_encrypt(),
1174 Camellia_ofb128_encrypt()
1176 See L</Deprecated low-level encryption functions>.
1180 CAST_encrypt(), CAST_decrypt(), CAST_set_key(), CAST_cbc_encrypt(),
1181 CAST_cfb64_encrypt(), CAST_ecb_encrypt(), CAST_ofb64_encrypt()
1183 See L</Deprecated low-level encryption functions>.
1184 The CAST algorithm has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1188 CMAC_CTX_new(), CMAC_CTX_cleanup(), CMAC_CTX_copy(), CMAC_CTX_free(),
1189 CMAC_CTX_get0_cipher_ctx()
1191 See L</Deprecated low-level MAC functions>.
1195 CMAC_Init(), CMAC_Update(), CMAC_Final(), CMAC_resume()
1197 See L</Deprecated low-level MAC functions>.
1201 CRYPTO_mem_ctrl(), CRYPTO_mem_debug_free(), CRYPTO_mem_debug_malloc(),
1202 CRYPTO_mem_debug_pop(), CRYPTO_mem_debug_push(), CRYPTO_mem_debug_realloc(),
1203 CRYPTO_mem_leaks(), CRYPTO_mem_leaks_cb(), CRYPTO_mem_leaks_fp(),
1204 CRYPTO_set_mem_debug()
1206 Memory-leak checking has been deprecated in favor of more modern development
1207 tools, such as compiler memory and leak sanitizers or Valgrind.
1211 d2i_DHparams(), d2i_DHxparams(), d2i_DSAparams(), d2i_DSAPrivateKey(),
1212 d2i_DSAPrivateKey_bio(), d2i_DSAPrivateKey_fp(), d2i_DSA_PUBKEY(),
1213 d2i_DSA_PUBKEY_bio(), d2i_DSA_PUBKEY_fp(), d2i_DSAPublicKey(),
1214 d2i_ECParameters(), d2i_ECPrivateKey(), d2i_ECPrivateKey_bio(),
1215 d2i_ECPrivateKey_fp(), d2i_EC_PUBKEY(), d2i_EC_PUBKEY_bio(),
1216 d2i_EC_PUBKEY_fp(), o2i_ECPublicKey(), d2i_RSAPrivateKey(),
1217 d2i_RSAPrivateKey_bio(), d2i_RSAPrivateKey_fp(), d2i_RSA_PUBKEY(),
1218 d2i_RSA_PUBKEY_bio(), d2i_RSA_PUBKEY_fp(), d2i_RSAPublicKey(),
1219 d2i_RSAPublicKey_bio(), d2i_RSAPublicKey_fp()
1221 See L</Deprecated i2d and d2i functions for low-level key types>
1225 DES_crypt(), DES_fcrypt(), DES_encrypt1(), DES_encrypt2(), DES_encrypt3(),
1226 DES_decrypt3(), DES_ede3_cbc_encrypt(), DES_ede3_cfb64_encrypt(),
1227 DES_ede3_cfb_encrypt(),DES_ede3_ofb64_encrypt(),
1228 DES_ecb_encrypt(), DES_ecb3_encrypt(), DES_ofb64_encrypt(), DES_ofb_encrypt(),
1229 DES_cfb64_encrypt DES_cfb_encrypt(), DES_cbc_encrypt(), DES_ncbc_encrypt(),
1230 DES_pcbc_encrypt(), DES_xcbc_encrypt(), DES_cbc_cksum(), DES_quad_cksum(),
1231 DES_check_key_parity(), DES_is_weak_key(), DES_key_sched(), DES_options(),
1232 DES_random_key(), DES_set_key(), DES_set_key_checked(), DES_set_key_unchecked(),
1233 DES_set_odd_parity(), DES_string_to_2keys(), DES_string_to_key()
1235 See L</Deprecated low-level encryption functions>.
1236 Algorithms for "DESX-CBC", "DES-ECB", "DES-CBC", "DES-OFB", "DES-CFB",
1237 "DES-CFB1" and "DES-CFB8" have been moved to the L<Legacy Provider|/Legacy Algorithms>.
1241 DH_bits(), DH_security_bits(), DH_size()
1243 Use L<EVP_PKEY_get_bits(3)>, L<EVP_PKEY_get_security_bits(3)> and
1244 L<EVP_PKEY_get_size(3)>.
1248 DH_check(), DH_check_ex(), DH_check_params(), DH_check_params_ex(),
1249 DH_check_pub_key(), DH_check_pub_key_ex()
1251 See L</Deprecated low-level validation functions>
1255 DH_clear_flags(), DH_test_flags(), DH_set_flags()
1257 The B<DH_FLAG_CACHE_MONT_P> flag has been deprecated without replacement.
1258 The B<DH_FLAG_TYPE_DH> and B<DH_FLAG_TYPE_DHX> have been deprecated.
1259 Use EVP_PKEY_is_a() to determine the type of a key.
1260 There is no replacement for setting these flags.
1264 DH_compute_key() DH_compute_key_padded()
1266 See L</Deprecated low-level key exchange functions>.
1270 DH_new(), DH_new_by_nid(), DH_free(), DH_up_ref()
1272 See L</Deprecated low-level object creation>
1276 DH_generate_key(), DH_generate_parameters_ex()
1278 See L</Deprecated low-level key generation functions>.
1282 DH_get0_pqg(), DH_get0_p(), DH_get0_q(), DH_get0_g(), DH_get0_key(),
1283 DH_get0_priv_key(), DH_get0_pub_key(), DH_get_length(), DH_get_nid()
1285 See L</Deprecated low-level key parameter getters>
1289 DH_get_1024_160(), DH_get_2048_224(), DH_get_2048_256()
1291 Applications should instead set the B<OSSL_PKEY_PARAM_GROUP_NAME> as specified in
1292 L<EVP_PKEY-DH(7)/DH parameters>) to one of "dh_1024_160", "dh_2048_224" or
1293 "dh_2048_256" when generating a DH key.
1299 Applications should use L<EVP_PKEY_CTX_set_dh_kdf_type(3)> instead.
1303 DH_get_default_method(), DH_get0_engine(), DH_meth_*(), DH_new_method(),
1304 DH_OpenSSL(), DH_get_ex_data(), DH_set_default_method(), DH_set_method(),
1307 See L</Providers are a replacement for engines and low-level method overrides>
1311 DHparams_print(), DHparams_print_fp()
1313 See L</Deprecated low-level key printing functions>
1317 DH_set0_key(), DH_set0_pqg(), DH_set_length()
1319 See L</Deprecated low-level key parameter setters>
1323 DSA_bits(), DSA_security_bits(), DSA_size()
1325 Use L<EVP_PKEY_get_bits(3)>, L<EVP_PKEY_get_security_bits(3)> and
1326 L<EVP_PKEY_get_size(3)>.
1330 DHparams_dup(), DSA_dup_DH()
1332 There is no direct replacement. Applications may use L<EVP_PKEY_copy_parameters(3)>
1333 and L<EVP_PKEY_dup(3)> instead.
1337 DSA_generate_key(), DSA_generate_parameters_ex()
1339 See L</Deprecated low-level key generation functions>.
1343 DSA_get0_engine(), DSA_get_default_method(), DSA_get_ex_data(),
1344 DSA_get_method(), DSA_meth_*(), DSA_new_method(), DSA_OpenSSL(),
1345 DSA_set_default_method(), DSA_set_ex_data(), DSA_set_method()
1347 See L</Providers are a replacement for engines and low-level method overrides>.
1351 DSA_get0_p(), DSA_get0_q(), DSA_get0_g(), DSA_get0_pqg(), DSA_get0_key(),
1352 DSA_get0_priv_key(), DSA_get0_pub_key()
1354 See L</Deprecated low-level key parameter getters>.
1358 DSA_new(), DSA_free(), DSA_up_ref()
1360 See L</Deprecated low-level object creation>
1366 There is no direct replacement. Applications may use L<EVP_PKEY_copy_parameters(3)>
1367 and L<EVP_PKEY_dup(3)> instead.
1371 DSAparams_print(), DSAparams_print_fp(), DSA_print(), DSA_print_fp()
1373 See L</Deprecated low-level key printing functions>
1377 DSA_set0_key(), DSA_set0_pqg()
1379 See L</Deprecated low-level key parameter setters>
1383 DSA_set_flags(), DSA_clear_flags(), DSA_test_flags()
1385 The B<DSA_FLAG_CACHE_MONT_P> flag has been deprecated without replacement.
1389 DSA_sign(), DSA_do_sign(), DSA_sign_setup(), DSA_verify(), DSA_do_verify()
1391 See L</Deprecated low-level signing functions>.
1397 See L</Deprecated low-level key exchange functions>.
1403 Applications may either set this using the helper function
1404 L<EVP_PKEY_CTX_set_ecdh_kdf_type(3)> or by setting an B<OSSL_PARAM> using the
1405 "kdf-type" as shown in L<EVP_KEYEXCH-ECDH(7)/EXAMPLES>
1409 ECDSA_sign(), ECDSA_sign_ex(), ECDSA_sign_setup(), ECDSA_do_sign(),
1410 ECDSA_do_sign_ex(), ECDSA_verify(), ECDSA_do_verify()
1412 See L</Deprecated low-level signing functions>.
1418 Applications should use L<EVP_PKEY_get_size(3)>.
1422 EC_GF2m_simple_method(), EC_GFp_mont_method(), EC_GFp_nist_method(),
1423 EC_GFp_nistp224_method(), EC_GFp_nistp256_method(), EC_GFp_nistp521_method(),
1424 EC_GFp_simple_method()
1426 There are no replacements for these functions. Applications should rely on the
1427 library automatically assigning a suitable method internally when an EC_GROUP
1432 EC_GROUP_clear_free()
1434 Use L<EC_GROUP_free(3)> instead.
1438 EC_GROUP_get_curve_GF2m(), EC_GROUP_get_curve_GFp(), EC_GROUP_set_curve_GF2m(),
1439 EC_GROUP_set_curve_GFp()
1441 Applications should use L<EC_GROUP_get_curve(3)> and L<EC_GROUP_set_curve(3)>.
1445 EC_GROUP_have_precompute_mult(), EC_GROUP_precompute_mult(),
1446 EC_KEY_precompute_mult()
1448 These functions are not widely used. Applications should instead switch to
1449 named curves which OpenSSL has hardcoded lookup tables for.
1453 EC_GROUP_new(), EC_GROUP_method_of(), EC_POINT_method_of()
1455 EC_METHOD is now an internal-only concept and a suitable EC_METHOD is assigned
1456 internally without application intervention.
1457 Users of EC_GROUP_new() should switch to a different suitable constructor.
1463 Applications should use L<EVP_PKEY_can_sign(3)> instead.
1469 See L</Deprecated low-level validation functions>
1473 EC_KEY_set_flags(), EC_KEY_get_flags(), EC_KEY_clear_flags()
1475 See L<EVP_PKEY-EC(7)/Common EC parameters> which handles flags as seperate
1476 parameters for B<OSSL_PKEY_PARAM_EC_POINT_CONVERSION_FORMAT>,
1477 B<OSSL_PKEY_PARAM_EC_GROUP_CHECK_TYPE>, B<OSSL_PKEY_PARAM_EC_ENCODING>,
1478 B<OSSL_PKEY_PARAM_USE_COFACTOR_ECDH> and
1479 B<OSSL_PKEY_PARAM_EC_INCLUDE_PUBLIC>.
1480 See also L<EVP_PKEY-EC(7)/EXAMPLES>
1484 EC_KEY_dup(), EC_KEY_copy()
1486 There is no direct replacement. Applications may use L<EVP_PKEY_copy_parameters(3)>
1487 and L<EVP_PKEY_dup(3)> instead.
1491 EC_KEY_decoded_from_explicit_params()
1493 There is no replacement.
1497 EC_KEY_generate_key()
1499 See L</Deprecated low-level key generation functions>.
1503 EC_KEY_get0_group(), EC_KEY_get0_private_key(), EC_KEY_get0_public_key(),
1504 EC_KEY_get_conv_form(), EC_KEY_get_enc_flags()
1506 See L</Deprecated low-level key parameter getters>.
1510 EC_KEY_get0_engine(), EC_KEY_get_default_method(), EC_KEY_get_method(),
1511 EC_KEY_new_method(), EC_KEY_get_ex_data(), EC_KEY_OpenSSL(),
1512 EC_KEY_set_ex_data(), EC_KEY_set_default_method(), EC_KEY_METHOD_*(),
1515 See L</Providers are a replacement for engines and low-level method overrides>
1519 EC_METHOD_get_field_type()
1521 Use L<EC_GROUP_get_field_type(3)> instead.
1522 See L</Providers are a replacement for engines and low-level method overrides>
1526 EC_KEY_key2buf(), EC_KEY_oct2key(), EC_KEY_oct2priv(), EC_KEY_priv2buf(),
1529 There are no replacements for these.
1533 EC_KEY_new(), EC_KEY_new_by_curve_name(), EC_KEY_free(), EC_KEY_up_ref()
1535 See L</Deprecated low-level object creation>
1539 EC_KEY_print(), EC_KEY_print_fp()
1541 See L</Deprecated low-level key printing functions>
1545 EC_KEY_set_asn1_flag(), EC_KEY_set_conv_form(), EC_KEY_set_enc_flags()
1547 See L</Deprecated low-level key parameter setters>.
1551 EC_KEY_set_group(), EC_KEY_set_private_key(), EC_KEY_set_public_key(),
1552 EC_KEY_set_public_key_affine_coordinates()
1554 See L</Deprecated low-level key parameter setters>.
1558 ECParameters_print(), ECParameters_print_fp(), ECPKParameters_print(),
1559 ECPKParameters_print_fp()
1561 See L</Deprecated low-level key printing functions>
1565 EC_POINT_bn2point(), EC_POINT_point2bn()
1567 These functions were not particularly useful, since EC point serialization
1568 formats are not individual big-endian integers.
1572 EC_POINT_get_affine_coordinates_GF2m(), EC_POINT_get_affine_coordinates_GFp(),
1573 EC_POINT_set_affine_coordinates_GF2m(), EC_POINT_set_affine_coordinates_GFp()
1575 Applications should use L<EC_POINT_get_affine_coordinates(3)> and
1576 L<EC_POINT_set_affine_coordinates(3)> instead.
1580 EC_POINT_get_Jprojective_coordinates_GFp(), EC_POINT_set_Jprojective_coordinates_GFp()
1582 These functions are not widely used. Applications should instead use the
1583 L<EC_POINT_set_affine_coordinates(3)> and L<EC_POINT_get_affine_coordinates(3)>
1588 EC_POINT_make_affine(), EC_POINTs_make_affine()
1590 There is no replacement. These functions were not widely used, and OpenSSL
1591 automatically performs this conversion when needed.
1595 EC_POINT_set_compressed_coordinates_GF2m(), EC_POINT_set_compressed_coordinates_GFp()
1597 Applications should use L<EC_POINT_set_compressed_coordinates(3)> instead.
1603 This function is not widely used. Applications should instead use the
1604 L<EC_POINT_mul(3)> function.
1610 All engine functions are deprecated. An engine should be rewritten as a provider.
1611 See L</Providers are a replacement for engines and low-level method overrides>.
1615 B<ERR_load_*()>, ERR_func_error_string(), ERR_get_error_line(),
1616 ERR_get_error_line_data(), ERR_get_state()
1618 OpenSSL now loads error strings automatically so these functions are not needed.
1622 ERR_peek_error_line_data(), ERR_peek_last_error_line_data()
1624 The new functions are L<ERR_peek_error_func(3)>, L<ERR_peek_last_error_func(3)>,
1625 L<ERR_peek_error_data(3)>, L<ERR_peek_last_error_data(3)>, L<ERR_get_error_all(3)>,
1626 L<ERR_peek_error_all(3)> and L<ERR_peek_last_error_all(3)>.
1627 Applications should use L<ERR_get_error_all(3)>, or pick information
1628 with ERR_peek functions and finish off with getting the error code by using
1629 L<ERR_get_error(3)>.
1633 EVP_CIPHER_CTX_iv(), EVP_CIPHER_CTX_iv_noconst(), EVP_CIPHER_CTX_original_iv()
1635 Applications should instead use L<EVP_CIPHER_CTX_get_updated_iv(3)>,
1636 L<EVP_CIPHER_CTX_get_updated_iv(3)> and L<EVP_CIPHER_CTX_get_original_iv(3)>
1638 See L<EVP_CIPHER_CTX_get_original_iv(3)> for further information.
1642 B<EVP_CIPHER_meth_*()>, EVP_MD_CTX_set_update_fn(), EVP_MD_CTX_update_fn(),
1645 See L</Providers are a replacement for engines and low-level method overrides>.
1649 EVP_PKEY_CTRL_PKCS7_ENCRYPT(), EVP_PKEY_CTRL_PKCS7_DECRYPT(),
1650 EVP_PKEY_CTRL_PKCS7_SIGN(), EVP_PKEY_CTRL_CMS_ENCRYPT(),
1651 EVP_PKEY_CTRL_CMS_DECRYPT(), and EVP_PKEY_CTRL_CMS_SIGN()
1653 These control operations are not invoked by the OpenSSL library anymore and
1654 are replaced by direct checks of the key operation against the key type
1655 when the operation is initialized.
1659 EVP_PKEY_CTX_get0_dh_kdf_ukm(), EVP_PKEY_CTX_get0_ecdh_kdf_ukm()
1661 See the "kdf-ukm" item in L<EVP_KEYEXCH-DH(7)/DH key exchange parameters> and
1662 L<EVP_KEYEXCH-ECDH(7)/ECDH Key Exchange parameters>.
1663 These functions are obsolete and should not be required.
1667 EVP_PKEY_CTX_set_rsa_keygen_pubexp()
1669 Applications should use L<EVP_PKEY_CTX_set1_rsa_keygen_pubexp(3)> instead.
1673 EVP_PKEY_cmp(), EVP_PKEY_cmp_parameters()
1675 Applications should use L<EVP_PKEY_eq(3)> and L<EVP_PKEY_parameters_eq(3)> instead.
1676 See L<EVP_PKEY_copy_parameters(3)> for further details.
1680 EVP_PKEY_encrypt_old(), EVP_PKEY_decrypt_old(),
1682 Applications should use L<EVP_PKEY_encrypt_init(3)> and L<EVP_PKEY_encrypt(3)> or
1683 L<EVP_PKEY_decrypt_init(3)> and L<EVP_PKEY_decrypt(3)> instead.
1689 This function returns NULL if the key comes from a provider.
1693 EVP_PKEY_get0_DH(), EVP_PKEY_get0_DSA(), EVP_PKEY_get0_EC_KEY(), EVP_PKEY_get0_RSA(),
1694 EVP_PKEY_get1_DH(), EVP_PKEY_get1_DSA(), EVP_PKEY_get1_EC_KEY and EVP_PKEY_get1_RSA(),
1695 EVP_PKEY_get0_hmac(), EVP_PKEY_get0_poly1305(), EVP_PKEY_get0_siphash()
1697 See L</Functions that return an internal key should be treated as read only>.
1701 B<EVP_PKEY_meth_*()>
1703 See L</Providers are a replacement for engines and low-level method overrides>.
1707 EVP_PKEY_new_CMAC_key()
1709 See L</Deprecated low-level MAC functions>.
1713 EVP_PKEY_assign(), EVP_PKEY_set1_DH(), EVP_PKEY_set1_DSA(),
1714 EVP_PKEY_set1_EC_KEY(), EVP_PKEY_set1_RSA()
1716 See L</Deprecated low-level key object getters and setters>
1720 EVP_PKEY_set1_tls_encodedpoint() EVP_PKEY_get1_tls_encodedpoint()
1722 These functions were previously used by libssl to set or get an encoded public
1723 key into/from an EVP_PKEY object. With OpenSSL 3.0 these are replaced by the more
1724 generic functions L<EVP_PKEY_set1_encoded_public_key(3)> and
1725 L<EVP_PKEY_get1_encoded_public_key(3)>.
1726 The old versions have been converted to deprecated macros that just call the
1731 EVP_PKEY_set1_engine(), EVP_PKEY_get0_engine()
1733 See L</Providers are a replacement for engines and low-level method overrides>.
1737 EVP_PKEY_set_alias_type()
1739 This function has been removed. There is no replacement.
1740 See L</EVP_PKEY_set_alias_type() method has been removed>
1744 HMAC_Init_ex(), HMAC_Update(), HMAC_Final(), HMAC_size()
1746 See L</Deprecated low-level MAC functions>.
1750 HMAC_CTX_new(), HMAC_CTX_free(), HMAC_CTX_copy(), HMAC_CTX_reset(),
1751 HMAC_CTX_set_flags(), HMAC_CTX_get_md()
1753 See L</Deprecated low-level MAC functions>.
1757 i2d_DHparams(), i2d_DHxparams()
1759 See L</Deprecated low-level key reading and writing functions>
1760 and L<d2i_RSAPrivateKey(3)/Migration>
1764 i2d_DSAparams(), i2d_DSAPrivateKey(), i2d_DSAPrivateKey_bio(),
1765 i2d_DSAPrivateKey_fp(), i2d_DSA_PUBKEY(), i2d_DSA_PUBKEY_bio(),
1766 i2d_DSA_PUBKEY_fp(), i2d_DSAPublicKey()
1768 See L</Deprecated low-level key reading and writing functions>
1769 and L<d2i_RSAPrivateKey(3)/Migration>
1773 i2d_ECParameters(), i2d_ECPrivateKey(), i2d_ECPrivateKey_bio(),
1774 i2d_ECPrivateKey_fp(), i2d_EC_PUBKEY(), i2d_EC_PUBKEY_bio(),
1775 i2d_EC_PUBKEY_fp(), i2o_ECPublicKey()
1777 See L</Deprecated low-level key reading and writing functions>
1778 and L<d2i_RSAPrivateKey(3)/Migration>
1782 i2d_RSAPrivateKey(), i2d_RSAPrivateKey_bio(), i2d_RSAPrivateKey_fp(),
1783 i2d_RSA_PUBKEY(), i2d_RSA_PUBKEY_bio(), i2d_RSA_PUBKEY_fp(),
1784 i2d_RSAPublicKey(), i2d_RSAPublicKey_bio(), i2d_RSAPublicKey_fp()
1786 See L</Deprecated low-level key reading and writing functions>
1787 and L<d2i_RSAPrivateKey(3)/Migration>
1791 IDEA_encrypt(), IDEA_set_decrypt_key(), IDEA_set_encrypt_key(),
1792 IDEA_cbc_encrypt(), IDEA_cfb64_encrypt(), IDEA_ecb_encrypt(),
1793 IDEA_ofb64_encrypt()
1795 See L</Deprecated low-level encryption functions>.
1796 IDEA has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1802 There is no replacement. This function returned a constant string.
1806 MD2(), MD2_Init(), MD2_Update(), MD2_Final()
1808 See L</Deprecated low-level encryption functions>.
1809 MD2 has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1815 There is no replacement. This function returned a constant string.
1819 MD4(), MD4_Init(), MD4_Update(), MD4_Final(), MD4_Transform()
1821 See L</Deprecated low-level encryption functions>.
1822 MD4 has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1826 MDC2(), MDC2_Init(), MDC2_Update(), MDC2_Final()
1828 See L</Deprecated low-level encryption functions>.
1829 MDC2 has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1833 MD5(), MD5_Init(), MD5_Update(), MD5_Final(), MD5_Transform()
1835 See L</Deprecated low-level encryption functions>.
1841 This undocumented function has no replacement.
1842 See L<config(5)/HISTORY> for more details.
1848 Use L<OSSL_HTTP_parse_url(3)> instead.
1852 B<OCSP_REQ_CTX> type and B<OCSP_REQ_CTX_*()> functions
1854 These methods were used to collect all necessary data to form a HTTP request,
1855 and to perform the HTTP transfer with that request. With OpenSSL 3.0, the
1856 type is B<OSSL_HTTP_REQ_CTX>, and the deprecated functions are replaced
1857 with B<OSSL_HTTP_REQ_CTX_*()>. See L<OSSL_HTTP_REQ_CTX(3)> for additional
1862 OPENSSL_fork_child(), OPENSSL_fork_parent(), OPENSSL_fork_prepare()
1864 There is no replacement for these functions. These pthread fork support methods
1865 were unused by OpenSSL.
1869 OSSL_STORE_ctrl(), OSSL_STORE_do_all_loaders(), OSSL_STORE_LOADER_get0_engine(),
1870 OSSL_STORE_LOADER_get0_scheme(), OSSL_STORE_LOADER_new(),
1871 OSSL_STORE_LOADER_set_attach(), OSSL_STORE_LOADER_set_close(),
1872 OSSL_STORE_LOADER_set_ctrl(), OSSL_STORE_LOADER_set_eof(),
1873 OSSL_STORE_LOADER_set_error(), OSSL_STORE_LOADER_set_expect(),
1874 OSSL_STORE_LOADER_set_find(), OSSL_STORE_LOADER_set_load(),
1875 OSSL_STORE_LOADER_set_open(), OSSL_STORE_LOADER_set_open_ex(),
1876 OSSL_STORE_register_loader(), OSSL_STORE_unregister_loader(),
1879 These functions helped applications and engines create loaders for
1880 schemes they supported. These are all deprecated and discouraged in favour of
1881 provider implementations, see L<provider-storemgmt(7)>.
1885 PEM_read_DHparams(), PEM_read_bio_DHparams(),
1886 PEM_read_DSAparams(), PEM_read_bio_DSAparams(),
1887 PEM_read_DSAPrivateKey(), PEM_read_DSA_PUBKEY(),
1888 PEM_read_bio_DSAPrivateKey and PEM_read_bio_DSA_PUBKEY(),
1889 PEM_read_ECPKParameters(), PEM_read_ECPrivateKey(), PEM_read_EC_PUBKEY(),
1890 PEM_read_bio_ECPKParameters(), PEM_read_bio_ECPrivateKey(), PEM_read_bio_EC_PUBKEY(),
1891 PEM_read_RSAPrivateKey(), PEM_read_RSA_PUBKEY(), PEM_read_RSAPublicKey(),
1892 PEM_read_bio_RSAPrivateKey(), PEM_read_bio_RSA_PUBKEY(), PEM_read_bio_RSAPublicKey(),
1893 PEM_write_bio_DHparams(), PEM_write_bio_DHxparams(), PEM_write_DHparams(), PEM_write_DHxparams(),
1894 PEM_write_DSAparams(), PEM_write_DSAPrivateKey(), PEM_write_DSA_PUBKEY(),
1895 PEM_write_bio_DSAparams(), PEM_write_bio_DSAPrivateKey(), PEM_write_bio_DSA_PUBKEY(),
1896 PEM_write_ECPKParameters(), PEM_write_ECPrivateKey(), PEM_write_EC_PUBKEY(),
1897 PEM_write_bio_ECPKParameters(), PEM_write_bio_ECPrivateKey(), PEM_write_bio_EC_PUBKEY(),
1898 PEM_write_RSAPrivateKey(), PEM_write_RSA_PUBKEY(), PEM_write_RSAPublicKey(),
1899 PEM_write_bio_RSAPrivateKey(), PEM_write_bio_RSA_PUBKEY(),
1900 PEM_write_bio_RSAPublicKey(),
1902 See L</Deprecated low-level key reading and writing functions>
1908 See L</Deprecated low-level encryption functions>.
1912 RAND_get_rand_method(), RAND_set_rand_method(), RAND_OpenSSL(),
1913 RAND_set_rand_engine()
1915 Applications should instead use L<RAND_set_DRBG_type(3)>,
1916 L<EVP_RAND(3)> and L<EVP_RAND(7)>.
1917 See L<RAND_set_rand_method(3)> for more details.
1921 RC2_encrypt(), RC2_decrypt(), RC2_set_key(), RC2_cbc_encrypt(), RC2_cfb64_encrypt(),
1922 RC2_ecb_encrypt(), RC2_ofb64_encrypt(),
1923 RC4(), RC4_set_key(), RC4_options(),
1924 RC5_32_encrypt(), RC5_32_set_key(), RC5_32_decrypt(), RC5_32_cbc_encrypt(),
1925 RC5_32_cfb64_encrypt(), RC5_32_ecb_encrypt(), RC5_32_ofb64_encrypt()
1927 See L</Deprecated low-level encryption functions>.
1928 The Algorithms "RC2", "RC4" and "RC5" have been moved to the L<Legacy Provider|/Legacy Algorithms>.
1932 RIPEMD160(), RIPEMD160_Init(), RIPEMD160_Update(), RIPEMD160_Final(),
1933 RIPEMD160_Transform()
1935 See L</Deprecated low-level digest functions>.
1936 The RIPE algorithm has been moved to the L<Legacy Provider|/Legacy Algorithms>.
1940 RSA_bits(), RSA_security_bits(), RSA_size()
1942 Use L<EVP_PKEY_get_bits(3)>, L<EVP_PKEY_get_security_bits(3)> and
1943 L<EVP_PKEY_get_size(3)>.
1947 RSA_check_key(), RSA_check_key_ex()
1949 See L</Deprecated low-level validation functions>
1953 RSA_clear_flags(), RSA_flags(), RSA_set_flags(), RSA_test_flags(),
1954 RSA_setup_blinding(), RSA_blinding_off(), RSA_blinding_on()
1956 All of these RSA flags have been deprecated without replacement:
1958 B<RSA_FLAG_BLINDING>, B<RSA_FLAG_CACHE_PRIVATE>, B<RSA_FLAG_CACHE_PUBLIC>,
1959 B<RSA_FLAG_EXT_PKEY>, B<RSA_FLAG_NO_BLINDING>, B<RSA_FLAG_THREAD_SAFE>
1960 B<RSA_METHOD_FLAG_NO_CHECK>
1964 RSA_generate_key_ex(), RSA_generate_multi_prime_key()
1966 See L</Deprecated low-level key generation functions>.
1972 See L</Providers are a replacement for engines and low-level method overrides>
1976 RSA_get0_crt_params(), RSA_get0_d(), RSA_get0_dmp1(), RSA_get0_dmq1(),
1977 RSA_get0_e(), RSA_get0_factors(), RSA_get0_iqmp(), RSA_get0_key(),
1978 RSA_get0_multi_prime_crt_params(), RSA_get0_multi_prime_factors(), RSA_get0_n(),
1979 RSA_get0_p(), RSA_get0_pss_params(), RSA_get0_q(),
1980 RSA_get_multi_prime_extra_count()
1982 See L</Deprecated low-level key parameter getters>
1986 RSA_new(), RSA_free(), RSA_up_ref()
1988 See L</Deprecated low-level object creation>.
1992 RSA_get_default_method(), RSA_get_ex_data and RSA_get_method()
1994 See L</Providers are a replacement for engines and low-level method overrides>.
2000 There is no replacement.
2004 B<RSA_meth_*()>, RSA_new_method(), RSA_null_method and RSA_PKCS1_OpenSSL()
2006 See L</Providers are a replacement for engines and low-level method overrides>.
2010 B<RSA_padding_add_*()>, B<RSA_padding_check_*()>
2012 See L</Deprecated low-level signing functions> and
2013 L</Deprecated low-level encryption functions>.
2017 RSA_print(), RSA_print_fp()
2019 See L</Deprecated low-level key printing functions>
2023 RSA_public_encrypt(), RSA_private_decrypt()
2025 See L</Deprecated low-level encryption functions>
2029 RSA_private_encrypt(), RSA_public_decrypt()
2031 This is equivalent to doing sign and verify recover operations (with a padding
2032 mode of none). See L</Deprecated low-level signing functions>.
2036 RSAPrivateKey_dup(), RSAPublicKey_dup()
2038 There is no direct replacement. Applications may use L<EVP_PKEY_dup(3)>.
2042 RSAPublicKey_it(), RSAPrivateKey_it()
2044 See L</Deprecated low-level key reading and writing functions>
2048 RSA_set0_crt_params(), RSA_set0_factors(), RSA_set0_key(),
2049 RSA_set0_multi_prime_params()
2051 See L</Deprecated low-level key parameter setters>.
2055 RSA_set_default_method(), RSA_set_method(), RSA_set_ex_data()
2057 See L</Providers are a replacement for engines and low-level method overrides>
2061 RSA_sign(), RSA_sign_ASN1_OCTET_STRING(), RSA_verify(),
2062 RSA_verify_ASN1_OCTET_STRING(), RSA_verify_PKCS1_PSS(),
2063 RSA_verify_PKCS1_PSS_mgf1()
2065 See L</Deprecated low-level signing functions>.
2069 RSA_X931_derive_ex(), RSA_X931_generate_key_ex(), RSA_X931_hash_id()
2071 There are no replacements for these functions.
2072 X931 padding can be set using L<EVP_SIGNATURE-RSA(7)/Signature Parameters>.
2073 See B<OSSL_SIGNATURE_PARAM_PAD_MODE>.
2077 SEED_encrypt(), SEED_decrypt(), SEED_set_key(), SEED_cbc_encrypt(),
2078 SEED_cfb128_encrypt(), SEED_ecb_encrypt(), SEED_ofb128_encrypt()
2080 See L</Deprecated low-level encryption functions>.
2081 The SEED algorithm has been moved to the L<Legacy Provider|/Legacy Algorithms>.
2085 SHA1_Init(), SHA1_Update(), SHA1_Final(), SHA1_Transform(),
2086 SHA224_Init(), SHA224_Update(), SHA224_Final(),
2087 SHA256_Init(), SHA256_Update(), SHA256_Final(), SHA256_Transform(),
2088 SHA384_Init(), SHA384_Update(), SHA384_Final(),
2089 SHA512_Init(), SHA512_Update(), SHA512_Final(), SHA512_Transform()
2091 See L</Deprecated low-level digest functions>.
2095 SRP_Calc_A(), SRP_Calc_B(), SRP_Calc_client_key(), SRP_Calc_server_key(),
2096 SRP_Calc_u(), SRP_Calc_x(), SRP_check_known_gN_param(), SRP_create_verifier(),
2097 SRP_create_verifier_BN(), SRP_get_default_gN(), SRP_user_pwd_free(), SRP_user_pwd_new(),
2098 SRP_user_pwd_set0_sv(), SRP_user_pwd_set1_ids(), SRP_user_pwd_set_gN(),
2099 SRP_VBASE_add0_user(), SRP_VBASE_free(), SRP_VBASE_get1_by_user(), SRP_VBASE_init(),
2100 SRP_VBASE_new(), SRP_Verify_A_mod_N(), SRP_Verify_B_mod_N()
2102 There are no replacements for the SRP functions.
2106 SSL_CTX_set_tmp_dh_callback(), SSL_set_tmp_dh_callback(),
2107 SSL_CTX_set_tmp_dh(), SSL_set_tmp_dh()
2109 These are used to set the Diffie-Hellman (DH) parameters that are to be used by
2110 servers requiring ephemeral DH keys. Instead applications should consider using
2111 the built-in DH parameters that are available by calling L<SSL_CTX_set_dh_auto(3)>
2112 or L<SSL_set_dh_auto(3)>. If custom parameters are necessary then applications can
2113 use the alternative functions L<SSL_CTX_set0_tmp_dh_pkey(3)> and
2114 L<SSL_set0_tmp_dh_pkey(3)>. There is no direct replacement for the "callback"
2115 functions. The callback was originally useful in order to have different
2116 parameters for export and non-export ciphersuites. Export ciphersuites are no
2117 longer supported by OpenSSL. Use of the callback functions should be replaced
2118 by one of the other methods described above.
2122 SSL_CTX_set_tlsext_ticket_key_cb()
2124 Use the new L<SSL_CTX_set_tlsext_ticket_key_evp_cb(3)> function instead.
2128 WHIRLPOOL(), WHIRLPOOL_Init(), WHIRLPOOL_Update(), WHIRLPOOL_Final(),
2129 WHIRLPOOL_BitUpdate()
2131 See L</Deprecated low-level digest functions>.
2132 The Whirlpool algorithm has been moved to the L<Legacy Provider|/Legacy Algorithms>.
2136 X509_certificate_type()
2138 This was an undocumented function. Applications can use L<X509_get0_pubkey(3)>
2139 and L<X509_get0_signature(3)> instead.
2143 X509_http_nbio(), X509_CRL_http_nbio()
2145 Use L<X509_load_http(3)> and L<X509_CRL_load_http(3)> instead.
2149 =head2 Using the FIPS Module in applications
2151 See L<fips_module(7)> and L<OSSL_PROVIDER-FIPS(7)> for details.
2153 =head2 OpenSSL command line application changes
2155 =head3 New applications
2157 L<B<openssl kdf>|openssl-kdf(1)> uses the new L<EVP_KDF(3)> API.
2158 L<B<openssl kdf>|openssl-mac(1)> uses the new L<EVP_MAC(3)> API.
2160 =head3 Added options
2162 B<-provider_path> and B<-provider> are available to all apps and can be used
2163 multiple times to load any providers, such as the 'legacy' provider or third
2164 party providers. If used then the 'default' provider would also need to be
2165 specified if required. The B<-provider_path> must be specified before the
2166 B<-provider> option.
2168 The B<list> app has many new options. See L<openssl-list(1)> for more
2171 B<-crl_lastupdate> and B<-crl_nextupdate> used by B<openssl ca> allows
2172 explicit setting of fields in the generated CRL.
2174 =head3 Removed options
2176 Interactive mode is not longer available.
2178 The B<-crypt> option used by B<openssl passwd>.
2179 The B<-c> option used by B<openssl x509>, B<openssl dhparam>,
2180 B<openssl dsaparam>, and B<openssl ecparam>.
2182 =head3 Other Changes
2184 The output of Command line applications may have minor changes.
2185 These are primarily changes in capitalisation and white space. However, in some
2186 cases, there are additional differences.
2187 For example, the DH parameters output from B<openssl dhparam> now lists 'P',
2188 'Q', 'G' and 'pcounter' instead of 'prime', 'generator', 'subgroup order' and
2189 'counter' respectively.
2191 The B<openssl> commands that read keys, certificates, and CRLs now
2192 automatically detect the PEM or DER format of the input files so it is not
2193 necessary to explicitly specify the input format anymore. However if the
2194 input format option is used the specified format will be required.
2196 B<openssl speed> no longer uses low-level API calls.
2197 This implies some of the performance numbers might not be comparable with the
2198 previous releases due to higher overhead. This applies particularly to
2199 measuring performance on smaller data chunks.
2201 b<openssl dhparam>, B<openssl dsa>, B<openssl gendsa>, B<openssl dsaparam>,
2202 B<openssl genrsa> and B<openssl rsa> have been modified to use PKEY APIs.
2203 B<openssl genrsa> and B<openssl rsa> now write PKCS #8 keys by default.
2205 =head3 Default settings
2207 "SHA256" is now the default digest for TS query used by B<openssl ts>.
2209 =head3 Deprecated apps
2211 B<openssl rsautl> is deprecated, use B<openssl pkeyutl> instead.
2212 B<openssl dhparam>, B<openssl dsa>, B<openssl gendsa>, B<openssl dsaparam>,
2213 B<openssl genrsa>, B<openssl rsa>, B<openssl genrsa> and B<openssl rsa> are
2214 now in maintenance mode and no new features will be added to them.
2222 TLS 1.3 FFDHE key exchange support added
2224 This uses DH safe prime named groups.
2228 Support for fully "pluggable" TLSv1.3 groups.
2230 This means that providers may supply their own group implementations (using
2231 either the "key exchange" or the "key encapsulation" methods) which will
2232 automatically be detected and used by libssl.
2236 SSL and SSL_CTX options are now 64 bit instead of 32 bit.
2238 The signatures of the functions to get and set options on SSL and
2239 SSL_CTX objects changed from "unsigned long" to "uint64_t" type.
2241 This may require source code changes. For example it is no longer possible
2242 to use the B<SSL_OP_> macro values in preprocessor C<#if> conditions.
2243 However it is still possible to test whether these macros are defined or not.
2245 See L<SSL_CTX_get_options(3)>, L<SSL_CTX_set_options(3)>,
2246 L<SSL_get_options(3)> and L<SSL_set_options(3)>.
2250 SSL_set1_host() and SSL_add1_host() Changes
2252 These functions now take IP literal addresses as well as actual hostnames.
2256 Added SSL option SSL_OP_CLEANSE_PLAINTEXT
2258 If the option is set, openssl cleanses (zeroizes) plaintext bytes from
2259 internal buffers after delivering them to the application. Note,
2260 the application is still responsible for cleansing other copies
2261 (e.g.: data received by L<SSL_read(3)>).
2265 Client-initiated renegotiation is disabled by default.
2267 To allow it, use the B<-client_renegotiation> option,
2268 the B<SSL_OP_ALLOW_CLIENT_RENEGOTIATION> flag, or the C<ClientRenegotiation>
2269 config parameter as appropriate.
2273 Secure renegotiation is now required by default for TLS connections
2275 Support for RFC 5746 secure renegotiation is now required by default for
2276 SSL or TLS connections to succeed. Applications that require the ability
2277 to connect to legacy peers will need to explicitly set
2278 SSL_OP_LEGACY_SERVER_CONNECT. Accordingly, SSL_OP_LEGACY_SERVER_CONNECT
2279 is no longer set as part of SSL_OP_ALL.
2283 Combining the Configure options no-ec and no-dh no longer disables TLSv1.3
2285 Typically if OpenSSL has no EC or DH algorithms then it cannot support
2286 connections with TLSv1.3. However OpenSSL now supports "pluggable" groups
2287 through providers. Therefore third party providers may supply group
2288 implementations even where there are no built-in ones. Attempting to create
2289 TLS connections in such a build without also disabling TLSv1.3 at run time or
2290 using third party provider groups may result in handshake failures. TLSv1.3
2291 can be disabled at compile time using the "no-tls1_3" Configure option.
2295 SSL_CTX_set_ciphersuites() and SSL_set_ciphersuites() changes.
2297 The methods now ignore unknown ciphers.
2301 Security callback change.
2303 The security callback, which can be customised by application code, supports
2304 the security operation SSL_SECOP_TMP_DH. This is defined to take an EVP_PKEY
2305 in the "other" parameter. In most places this is what is passed. All these
2306 places occur server side. However there was one client side call of this
2307 security operation and it passed a DH object instead. This is incorrect
2308 according to the definition of SSL_SECOP_TMP_DH, and is inconsistent with all
2309 of the other locations. Therefore this client side call has been changed to
2310 pass an EVP_PKEY instead.
2314 New SSL option SSL_OP_IGNORE_UNEXPECTED_EOF
2316 The SSL option SSL_OP_IGNORE_UNEXPECTED_EOF is introduced. If that option
2317 is set, an unexpected EOF is ignored, it pretends a close notify was received
2318 instead and so the returned error becomes SSL_ERROR_ZERO_RETURN.
2322 The security strength of SHA1 and MD5 based signatures in TLS has been reduced.
2324 This results in SSL 3, TLS 1.0, TLS 1.1 and DTLS 1.0 no longer
2325 working at the default security level of 1 and instead requires security
2326 level 0. The security level can be changed either using the cipher string
2327 with `C<@SECLEVEL>, or calling L<SSL_CTX_set_security_level(3)>. This also means
2328 that where the signature algorithms extension is missing from a ClientHello
2329 then the handshake will fail in TLS 1.2 at security level 1. This is because,
2330 although this extension is optional, failing to provide one means that
2331 OpenSSL will fallback to a default set of signature algorithms. This default
2332 set requires the availability of SHA1.
2336 X509 certificates signed using SHA1 are no longer allowed at security level 1 and above.
2338 In TLS/SSL the default security level is 1. It can be set either using the cipher
2339 string with C<@SECLEVEL>, or calling L<SSL_CTX_set_security_level(3)>. If the
2340 leaf certificate is signed with SHA-1, a call to L<SSL_CTX_use_certificate(3)>
2341 will fail if the security level is not lowered first.
2342 Outside TLS/SSL, the default security level is -1 (effectively 0). It can
2343 be set using L<X509_VERIFY_PARAM_set_auth_level(3)> or using the B<-auth_level>
2344 options of the commands.
2354 Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
2356 Licensed under the Apache License 2.0 (the "License"). You may not use
2357 this file except in compliance with the License. You can obtain a copy
2358 in the file LICENSE in the source distribution or at
2359 L<https://www.openssl.org/source/license.html>.