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