aboutsummaryrefslogtreecommitdiff
path: root/crypto/openssl/doc/crypto/DH_size.pod
blob: 97f26fda7855e8e865e9e9d7893a4d3d15d7f124 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
=pod

=head1 NAME

DH_size - get Diffie-Hellman prime size

=head1 SYNOPSIS

 #include <openssl/dh.h>

 int DH_size(DH *dh);

=head1 DESCRIPTION

This function returns the Diffie-Hellman size in bytes. It can be used
to determine how much memory must be allocated for the shared secret
computed by DH_compute_key().

B<dh-E<gt>p> must not be B<NULL>.

=head1 RETURN VALUE

The size in bytes.

=head1 SEE ALSO

L<dh(3)|dh(3)>, L<DH_generate_key(3)|DH_generate_key(3)>

=head1 HISTORY

DH_size() is available in all versions of SSLeay and OpenSSL.

=cut