xref: /freebsd/crypto/openssl/doc/man3/DH_get_1024_160.pod (revision 0fca6ea1d4eea4c934cfff25ac9ee8ad6fe95583)
1=pod
2
3=head1 NAME
4
5DH_get_1024_160,
6DH_get_2048_224,
7DH_get_2048_256,
8BN_get0_nist_prime_192,
9BN_get0_nist_prime_224,
10BN_get0_nist_prime_256,
11BN_get0_nist_prime_384,
12BN_get0_nist_prime_521,
13BN_get_rfc2409_prime_768,
14BN_get_rfc2409_prime_1024,
15BN_get_rfc3526_prime_1536,
16BN_get_rfc3526_prime_2048,
17BN_get_rfc3526_prime_3072,
18BN_get_rfc3526_prime_4096,
19BN_get_rfc3526_prime_6144,
20BN_get_rfc3526_prime_8192
21- Create standardized public primes or DH pairs
22
23=head1 SYNOPSIS
24
25 #include <openssl/dh.h>
26
27 const BIGNUM *BN_get0_nist_prime_192(void);
28 const BIGNUM *BN_get0_nist_prime_224(void);
29 const BIGNUM *BN_get0_nist_prime_256(void);
30 const BIGNUM *BN_get0_nist_prime_384(void);
31 const BIGNUM *BN_get0_nist_prime_521(void);
32
33 BIGNUM *BN_get_rfc2409_prime_768(BIGNUM *bn);
34 BIGNUM *BN_get_rfc2409_prime_1024(BIGNUM *bn);
35 BIGNUM *BN_get_rfc3526_prime_1536(BIGNUM *bn);
36 BIGNUM *BN_get_rfc3526_prime_2048(BIGNUM *bn);
37 BIGNUM *BN_get_rfc3526_prime_3072(BIGNUM *bn);
38 BIGNUM *BN_get_rfc3526_prime_4096(BIGNUM *bn);
39 BIGNUM *BN_get_rfc3526_prime_6144(BIGNUM *bn);
40 BIGNUM *BN_get_rfc3526_prime_8192(BIGNUM *bn);
41
42The following functions have been deprecated since OpenSSL 3.0, and can be
43hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
44see L<openssl_user_macros(7)>:
45
46 #include <openssl/dh.h>
47
48 DH *DH_get_1024_160(void);
49 DH *DH_get_2048_224(void);
50 DH *DH_get_2048_256(void);
51
52=head1 DESCRIPTION
53
54DH_get_1024_160(), DH_get_2048_224(), and DH_get_2048_256() each return
55a DH object for the IETF RFC 5114 value. These functions are deprecated.
56Applications should instead use EVP_PKEY_CTX_set_dh_rfc5114() and
57EVP_PKEY_CTX_set_dhx_rfc5114() as described in L<EVP_PKEY_CTX_ctrl(3)> or
58by setting the B<OSSL_PKEY_PARAM_GROUP_NAME> as specified in
59L<EVP_PKEY-DH(7)/DH parameters>) to one of "dh_1024_160", "dh_2048_224" or
60"dh_2048_256".
61
62BN_get0_nist_prime_192(), BN_get0_nist_prime_224(), BN_get0_nist_prime_256(),
63BN_get0_nist_prime_384(), and BN_get0_nist_prime_521() functions return
64a BIGNUM for the specific NIST prime curve (e.g., P-256).
65
66BN_get_rfc2409_prime_768(), BN_get_rfc2409_prime_1024(),
67BN_get_rfc3526_prime_1536(), BN_get_rfc3526_prime_2048(),
68BN_get_rfc3526_prime_3072(), BN_get_rfc3526_prime_4096(),
69BN_get_rfc3526_prime_6144(), and BN_get_rfc3526_prime_8192() functions
70return a BIGNUM for the specified size from IETF RFC 2409.  If B<bn>
71is not NULL, the BIGNUM will be set into that location as well.
72
73=head1 RETURN VALUES
74
75Defined above.
76
77=head1 HISTORY
78
79The functions DH_get_1024_160(), DH_get_2048_224() and DH_get_2048_256() were
80deprecated in OpenSSL 3.0.
81
82=head1 COPYRIGHT
83
84Copyright 2016-2021 The OpenSSL Project Authors. All Rights Reserved.
85
86Licensed under the Apache License 2.0 (the "License").  You may not use
87this file except in compliance with the License.  You can obtain a copy
88in the file LICENSE in the source distribution or at
89L<https://www.openssl.org/source/license.html>.
90
91=cut
92