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