xref: /openssl/doc/man3/DH_new_by_nid.pod (revision 65b41ab3)
1=pod
2
3=head1 NAME
4
5DH_new_by_nid, DH_get_nid - create or get DH named parameters
6
7=head1 SYNOPSIS
8
9 #include <openssl/dh.h>
10
11The following functions have been deprecated since OpenSSL 3.0, and can be
12hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
13see L<openssl_user_macros(7)>:
14
15 DH *DH_new_by_nid(int nid);
16
17 int DH_get_nid(const DH *dh);
18
19=head1 DESCRIPTION
20
21DH_new_by_nid() creates and returns a DH structure containing named parameters
22B<nid>. Currently B<nid> must be B<NID_ffdhe2048>, B<NID_ffdhe3072>,
23B<NID_ffdhe4096>, B<NID_ffdhe6144>, B<NID_ffdhe8192>,
24B<NID_modp_1536>, B<NID_modp_2048>, B<NID_modp_3072>,
25B<NID_modp_4096>, B<NID_modp_6144> or B<NID_modp_8192>.
26
27DH_get_nid() determines if the parameters contained in B<dh> match
28any named safe prime group. It returns the NID corresponding to the matching
29parameters or B<NID_undef> if there is no match.
30This function is deprecated.
31
32=head1 RETURN VALUES
33
34DH_new_by_nid() returns a set of DH parameters or B<NULL> if an error occurred.
35
36DH_get_nid() returns the NID of the matching set of parameters for p and g
37and optionally q, otherwise it returns B<NID_undef> if there is no match.
38
39=head1 HISTORY
40
41All of these functions were deprecated in OpenSSL 3.0.
42
43=head1 COPYRIGHT
44
45Copyright 2017-2020 The OpenSSL Project Authors. All Rights Reserved.
46
47Licensed under the Apache License 2.0 (the "License").  You may not use
48this file except in compliance with the License.  You can obtain a copy
49in the file LICENSE in the source distribution or at
50L<https://www.openssl.org/source/license.html>.
51
52=cut
53