xref: /freebsd/crypto/openssl/doc/man3/DH_new_by_nid.pod (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1=pod
2
3=head1 NAME
4
5DH_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
15DH_new_by_nid() creates and returns a DH structure containing named parameters
16B<nid>. Currently B<nid> must be B<NID_ffdhe2048>, B<NID_ffdhe3072>,
17B<NID_ffdhe4096>, B<NID_ffdhe6144> or B<NID_ffdhe8192>.
18
19DH_get_nid() determines if the parameters contained in B<dh> match
20any named set. It returns the NID corresponding to the matching parameters or
21B<NID_undef> if there is no match.
22
23=head1 RETURN VALUES
24
25DH_new_by_nid() returns a set of DH parameters or B<NULL> if an error occurred.
26
27DH_get_nid() returns the NID of the matching set of parameters or
28B<NID_undef> if there is no match.
29
30=head1 COPYRIGHT
31
32Copyright 2017 The OpenSSL Project Authors. All Rights Reserved.
33
34Licensed under the OpenSSL license (the "License").  You may not use
35this file except in compliance with the License.  You can obtain a copy
36in the file LICENSE in the source distribution or at
37L<https://www.openssl.org/source/license.html>.
38
39=cut
40