Debian Codegraph @

upstream/debian-unstable/man3/DH_get_1024_160.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "DH_GET_1024_160 3SSL"
58 .TH DH_GET_1024_160 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 DH_get_1024_160,
65 DH_get_2048_224,
66 DH_get_2048_256,
67 BN_get0_nist_prime_192,
68 BN_get0_nist_prime_224,
69 BN_get0_nist_prime_256,
70 BN_get0_nist_prime_384,
71 BN_get0_nist_prime_521,
72 BN_get_rfc2409_prime_768,
73 BN_get_rfc2409_prime_1024,
74 BN_get_rfc3526_prime_1536,
75 BN_get_rfc3526_prime_2048,
76 BN_get_rfc3526_prime_3072,
77 BN_get_rfc3526_prime_4096,
78 BN_get_rfc3526_prime_6144,
79 BN_get_rfc3526_prime_8192
80 \&\- Create standardized public primes or DH pairs
81 .SH SYNOPSIS
82 .IX Header "SYNOPSIS"
83 .Vb 1
84 \& #include <openssl/dh.h>
85 \&
86 \& const BIGNUM *BN_get0_nist_prime_192(void);
87 \& const BIGNUM *BN_get0_nist_prime_224(void);
88 \& const BIGNUM *BN_get0_nist_prime_256(void);
89 \& const BIGNUM *BN_get0_nist_prime_384(void);
90 \& const BIGNUM *BN_get0_nist_prime_521(void);
91 \&
92 \& BIGNUM *BN_get_rfc2409_prime_768(BIGNUM *bn);
93 \& BIGNUM *BN_get_rfc2409_prime_1024(BIGNUM *bn);
94 \& BIGNUM *BN_get_rfc3526_prime_1536(BIGNUM *bn);
95 \& BIGNUM *BN_get_rfc3526_prime_2048(BIGNUM *bn);
96 \& BIGNUM *BN_get_rfc3526_prime_3072(BIGNUM *bn);
97 \& BIGNUM *BN_get_rfc3526_prime_4096(BIGNUM *bn);
98 \& BIGNUM *BN_get_rfc3526_prime_6144(BIGNUM *bn);
99 \& BIGNUM *BN_get_rfc3526_prime_8192(BIGNUM *bn);
100 .Ve
101 .PP
102 The following functions have been deprecated since OpenSSL 3.0, and can be
103 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
104 see \fBopenssl_user_macros\fR\|(7):
105 .PP
106 .Vb 1
107 \& #include <openssl/dh.h>
108 \&
109 \& DH *DH_get_1024_160(void);
110 \& DH *DH_get_2048_224(void);
111 \& DH *DH_get_2048_256(void);
112 .Ve
113 .SH DESCRIPTION
114 .IX Header "DESCRIPTION"
115 \&\fBDH_get_1024_160()\fR, \fBDH_get_2048_224()\fR, and \fBDH_get_2048_256()\fR each return
116 a DH object for the IETF RFC 5114 value. These functions are deprecated.
117 Applications should instead use \fBEVP_PKEY_CTX_set_dh_rfc5114()\fR and
118 \&\fBEVP_PKEY_CTX_set_dhx_rfc5114()\fR as described in \fBEVP_PKEY_CTX_ctrl\fR\|(3) or
119 by setting the \fBOSSL_PKEY_PARAM_GROUP_NAME\fR as specified in
120 "DH parameters" in \fBEVP_PKEY\-DH\fR\|(7)) to one of "dh_1024_160", "dh_2048_224" or
121 "dh_2048_256".
122 .PP
123 \&\fBBN_get0_nist_prime_192()\fR, \fBBN_get0_nist_prime_224()\fR, \fBBN_get0_nist_prime_256()\fR,
124 \&\fBBN_get0_nist_prime_384()\fR, and \fBBN_get0_nist_prime_521()\fR functions return
125 a BIGNUM for the specific NIST prime curve (e.g., P\-256).
126 .PP
127 \&\fBBN_get_rfc2409_prime_768()\fR, \fBBN_get_rfc2409_prime_1024()\fR,
128 \&\fBBN_get_rfc3526_prime_1536()\fR, \fBBN_get_rfc3526_prime_2048()\fR,
129 \&\fBBN_get_rfc3526_prime_3072()\fR, \fBBN_get_rfc3526_prime_4096()\fR,
130 \&\fBBN_get_rfc3526_prime_6144()\fR, and \fBBN_get_rfc3526_prime_8192()\fR functions
131 return a BIGNUM for the specified size from IETF RFC 2409. If \fBbn\fR
132 is not NULL, the BIGNUM will be set into that location as well.
133 .SH "RETURN VALUES"
134 .IX Header "RETURN VALUES"
135 Defined above.
136 .SH HISTORY
137 .IX Header "HISTORY"
138 The functions \fBDH_get_1024_160()\fR, \fBDH_get_2048_224()\fR and \fBDH_get_2048_256()\fR were
139 deprecated in OpenSSL 3.0.
140 .SH COPYRIGHT
141 .IX Header "COPYRIGHT"
142 Copyright 2016\-2021 The OpenSSL Project Authors. All Rights Reserved.
143 .PP
144 Licensed under the Apache License 2.0 (the "License"). You may not use
145 this file except in compliance with the License. You can obtain a copy
146 in the file LICENSE in the source distribution or at
147 <https://www.openssl.org/source/license.html>.