]>
Commit | Line | Data |
---|---|---|
4486d0cd UM |
1 | =pod |
2 | ||
3 | =head1 NAME | |
4 | ||
6a2da303 PY |
5 | DH_size, DH_bits, DH_security_bits - get Diffie-Hellman prime size and |
6 | security bits | |
4486d0cd UM |
7 | |
8 | =head1 SYNOPSIS | |
9 | ||
6a2da303 | 10 | #include <openssl/dh.h> |
4486d0cd | 11 | |
6a2da303 | 12 | int DH_size(const DH *dh); |
26c79d56 | 13 | |
6a2da303 PY |
14 | int DH_bits(const DH *dh); |
15 | ||
16 | int DH_security_bits(const DH *dh); | |
4486d0cd UM |
17 | |
18 | =head1 DESCRIPTION | |
19 | ||
26c79d56 | 20 | DH_size() returns the Diffie-Hellman prime size in bytes. It can be used |
4486d0cd | 21 | to determine how much memory must be allocated for the shared secret |
6a2da303 | 22 | computed by L<DH_compute_key(3)>. |
4486d0cd | 23 | |
26c79d56 KR |
24 | DH_bits() returns the number of significant bits. |
25 | ||
26 | B<dh> and B<dh-E<gt>p> must not be B<NULL>. | |
4486d0cd | 27 | |
6a2da303 PY |
28 | DH_security_bits() returns the number of security bits of the given B<dh> |
29 | key. See L<BN_security_bits(3)>. | |
30 | ||
1f13ad31 | 31 | =head1 RETURN VALUES |
4486d0cd | 32 | |
6a2da303 PY |
33 | DH_size() returns the prime size of Diffie-Hellman in bytes. |
34 | ||
35 | DH_bits() returns the number of bits in the key. | |
36 | ||
37 | DH_security_bits() returns the number of security bits. | |
4486d0cd UM |
38 | |
39 | =head1 SEE ALSO | |
40 | ||
b97fdb57 | 41 | L<DH_new(3)>, L<DH_generate_key(3)>, |
9b86974e | 42 | L<BN_num_bits(3)> |
4486d0cd UM |
43 | |
44 | =head1 HISTORY | |
45 | ||
fc5ecadd | 46 | The DH_bits() function was added in OpenSSL 1.1.0. |
4486d0cd | 47 | |
e2f92610 RS |
48 | =head1 COPYRIGHT |
49 | ||
61f805c1 | 50 | Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved. |
e2f92610 | 51 | |
4746f25a | 52 | Licensed under the Apache License 2.0 (the "License"). You may not use |
e2f92610 RS |
53 | this file except in compliance with the License. You can obtain a copy |
54 | in the file LICENSE in the source distribution or at | |
55 | L<https://www.openssl.org/source/license.html>. | |
56 | ||
57 | =cut |