]> git.ipfire.org Git - thirdparty/openssl.git/blame - doc/crypto/DH_size.pod
Document the DH library, and make some minor changes along the way.
[thirdparty/openssl.git] / doc / crypto / DH_size.pod
CommitLineData
4486d0cd
UM
1=pod
2
3=head1 NAME
4
5DH_size - Get Diffie-Hellman prime size
6
7=head1 SYNOPSIS
8
9 #include <openssl/dh.h>
10
11 int DH_size(DH *dh);
12
13=head1 DESCRIPTION
14
15This function returns the Diffie-Hellman size in bytes. It can be used
16to determine how much memory must be allocated for the shared secret
17computed by DH_compute_key().
18
19B<dh-E<gt>p> must not be B<NULL>.
20
21=head1 RETURN VALUE
22
23The size in bytes.
24
25=head1 SEE ALSO
26
27dh(3), DH_generate_key(3)
28
29=head1 HISTORY
30
31DH_size() is available in all versions of SSLeay and OpenSSL.
32
33=cut