]>
Commit | Line | Data |
---|---|---|
5368bf05 DSH |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
5 | DH_new_by_nid, DH_get_nid - get or find DH named parameters | |
6 | ||
7 | =head1 SYNOPSIS | |
8 | ||
9 | #include <openssl/dh.h> | |
10 | DH *DH_new_by_nid(int nid); | |
11 | int *DH_get_nid(const DH *dh); | |
12 | ||
13 | =head1 DESCRIPTION | |
14 | ||
15 | DH_new_by_nid() creates and returns a DH structure containing named parameters | |
16 | B<nid>. Currently B<nid> must be B<NID_ffdhe2048>, B<NID_ffdhe3072>, | |
17 | B<NID_ffdhe4096>, B<NID_ffdhe6144> or B<NID_ffdhe8192>. | |
18 | ||
19 | DH_get_nid() determines if the parameters contained in B<dh> match | |
20 | any named set. It returns the NID corresponding to the matching parameters or | |
21 | B<NID_undef> if there is no match. | |
22 | ||
23 | =head1 RETURN VALUES | |
24 | ||
25 | DH_new_by_nid() returns a set of DH parameters or B<NULL> if an error occurred. | |
26 | ||
27 | DH_get_nid() returns the NID of the matching set of parameters or | |
28 | B<NID_undef> if there is no match. | |
29 | ||
30 | =head1 COPYRIGHT | |
31 | ||
32 | Copyright 2017 The OpenSSL Project Authors. All Rights Reserved. | |
33 | ||
4746f25a | 34 | Licensed under the Apache License 2.0 (the "License"). You may not use |
5368bf05 DSH |
35 | this file except in compliance with the License. You can obtain a copy |
36 | in the file LICENSE in the source distribution or at | |
37 | L<https://www.openssl.org/source/license.html>. | |
38 | ||
39 | =cut |