Properly document deprecation of DH_new() and related functions

Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Todd Short <todd.short@me.com>
Reviewed-by: Hugo Landau <hlandau@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/18925)
This commit is contained in:
Tomas Mraz 2022-08-01 13:08:45 +02:00 committed by Hugo Landau
parent fae06b5779
commit 65b41ab319
2 changed files with 15 additions and 3 deletions

View File

@ -8,6 +8,10 @@ DH_new, DH_free - allocate and free DH objects
#include <openssl/dh.h>
The following functions have been deprecated since OpenSSL 3.0, and can be
hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
see L<openssl_user_macros(7)>:
DH* DH_new(void);
void DH_free(DH *dh);
@ -32,7 +36,14 @@ DH_free() returns no value.
L<DH_new(3)>, L<ERR_get_error(3)>,
L<DH_generate_parameters(3)>,
L<DH_generate_key(3)>
L<DH_generate_key(3)>,
L<EVP_PKEY-DH(7)>
=head1 HISTORY
All of these functions were deprecated in OpenSSL 3.0.
For replacement see EVP_PKEY-DH(7).
=head1 COPYRIGHT

View File

@ -7,12 +7,13 @@ DH_new_by_nid, DH_get_nid - create or get DH named parameters
=head1 SYNOPSIS
#include <openssl/dh.h>
DH *DH_new_by_nid(int nid);
The following functions have been deprecated since OpenSSL 3.0, and can be
hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
see L<openssl_user_macros(7)>:
DH *DH_new_by_nid(int nid);
int DH_get_nid(const DH *dh);
=head1 DESCRIPTION
@ -37,7 +38,7 @@ and optionally q, otherwise it returns B<NID_undef> if there is no match.
=head1 HISTORY
The DH_get_nid() function was deprecated in OpenSSL 3.0.
All of these functions were deprecated in OpenSSL 3.0.
=head1 COPYRIGHT