Debian Codegraph @

upstream/debian-unstable/man3/DH_size.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_SIZE 3SSL"
58 .TH DH_SIZE 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_size, DH_bits, DH_security_bits \- get Diffie\-Hellman prime size and
65 security bits
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/dh.h>
70 .Ve
71 .PP
72 The following functions have been deprecated since OpenSSL 3.0, and can be
73 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
74 see \fBopenssl_user_macros\fR\|(7):
75 .PP
76 .Vb 1
77 \& int DH_bits(const DH *dh);
78 \&
79 \& int DH_size(const DH *dh);
80 \&
81 \& int DH_security_bits(const DH *dh);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 The functions described on this page are deprecated.
86 Applications should instead use \fBEVP_PKEY_get_bits\fR\|(3),
87 \&\fBEVP_PKEY_get_security_bits\fR\|(3) and \fBEVP_PKEY_get_size\fR\|(3).
88 .PP
89 \&\fBDH_bits()\fR returns the number of significant bits.
90 .PP
91 \&\fBdh\fR and \fBdh\->p\fR must not be \fBNULL\fR.
92 .PP
93 \&\fBDH_size()\fR returns the Diffie-Hellman prime size in bytes. It can be used
94 to determine how much memory must be allocated for the shared secret
95 computed by \fBDH_compute_key\fR\|(3).
96 .PP
97 \&\fBDH_security_bits()\fR returns the number of security bits of the given \fBdh\fR
98 key. See \fBBN_security_bits\fR\|(3).
99 .SH "RETURN VALUES"
100 .IX Header "RETURN VALUES"
101 \&\fBDH_bits()\fR returns the number of bits in the key, or \-1 if
102 \&\fBdh\fR doesn't hold any key parameters.
103 .PP
104 \&\fBDH_size()\fR returns the prime size of Diffie-Hellman in bytes, or \-1 if
105 \&\fBdh\fR doesn't hold any key parameters.
106 .PP
107 \&\fBDH_security_bits()\fR returns the number of security bits, or \-1 if
108 \&\fBdh\fR doesn't hold any key parameters.
109 .SH "SEE ALSO"
110 .IX Header "SEE ALSO"
111 \&\fBEVP_PKEY_get_bits\fR\|(3),
112 \&\fBDH_new\fR\|(3), \fBDH_generate_key\fR\|(3),
113 \&\fBBN_num_bits\fR\|(3)
114 .SH HISTORY
115 .IX Header "HISTORY"
116 All functions were deprecated in OpenSSL 3.0.
117 .SH COPYRIGHT
118 .IX Header "COPYRIGHT"
119 Copyright 2000\-2021 The OpenSSL Project Authors. All Rights Reserved.
120 .PP
121 Licensed under the Apache License 2.0 (the "License"). You may not use
122 this file except in compliance with the License. You can obtain a copy
123 in the file LICENSE in the source distribution or at
124 <https://www.openssl.org/source/license.html>.