projects
/
openssl.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
evp_rand: documentation
[openssl.git]
/
doc
/
man3
/
DH_new_by_nid.pod
diff --git
a/doc/man3/DH_new_by_nid.pod
b/doc/man3/DH_new_by_nid.pod
index 5fd71ffb5a9e6c7cb332c4dc69cd4326bc65b036..163be09fedcb6e1d0bb2e6f34e4f9a849288f2d4 100644
(file)
--- a/
doc/man3/DH_new_by_nid.pod
+++ b/
doc/man3/DH_new_by_nid.pod
@@
-2,13
+2,18
@@
=head1 NAME
=head1 NAME
-DH_new_by_nid, DH_get_nid -
get or find
DH named parameters
+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);
=head1 SYNOPSIS
#include <openssl/dh.h>
DH *DH_new_by_nid(int nid);
- int *DH_get_nid(DH *dh);
+
+Deprecated since OpenSSL 3.0, can be hidden entirely by defining
+B<OPENSSL_API_COMPAT> with a suitable version value, see
+L<openssl_user_macros(7)>:
+
+ int DH_get_nid(const DH *dh);
=head1 DESCRIPTION
=head1 DESCRIPTION
@@
-18,17
+23,21
@@
B<NID_ffdhe4096>, B<NID_ffdhe6144>, B<NID_ffdhe8192>,
B<NID_modp_1536>, B<NID_modp_2048>, B<NID_modp_3072>,
B<NID_modp_4096>, B<NID_modp_6144> or B<NID_modp_8192>.
B<NID_modp_1536>, B<NID_modp_2048>, B<NID_modp_3072>,
B<NID_modp_4096>, B<NID_modp_6144> or B<NID_modp_8192>.
-
DH_get_nid() determines if the parameters contained in B<dh> match
DH_get_nid() determines if the parameters contained in B<dh> match
-any named set. It returns the NID corresponding to the matching parameters or
-B<NID_undef> if there is no match.
+any named safe prime group. It returns the NID corresponding to the matching
+parameters or B<NID_undef> if there is no match.
+This function is deprecated.
=head1 RETURN VALUES
DH_new_by_nid() returns a set of DH parameters or B<NULL> if an error occurred.
=head1 RETURN VALUES
DH_new_by_nid() returns a set of DH parameters or B<NULL> if an error occurred.
-DH_get_nid() returns the NID of the matching set of parameters or
-B<NID_undef> if there is no match.
+DH_get_nid() returns the NID of the matching set of parameters for p and g
+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.
=head1 COPYRIGHT
=head1 COPYRIGHT