xref: /onnv-gate/usr/src/common/openssl/doc/crypto/DH_size.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948DH_size - get Diffie-Hellman prime size
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948 #include <openssl/dh.h>
10*2175Sjp161948
11*2175Sjp161948 int DH_size(DH *dh);
12*2175Sjp161948
13*2175Sjp161948=head1 DESCRIPTION
14*2175Sjp161948
15*2175Sjp161948This function returns the Diffie-Hellman size in bytes. It can be used
16*2175Sjp161948to determine how much memory must be allocated for the shared secret
17*2175Sjp161948computed by DH_compute_key().
18*2175Sjp161948
19*2175Sjp161948B<dh-E<gt>p> must not be B<NULL>.
20*2175Sjp161948
21*2175Sjp161948=head1 RETURN VALUE
22*2175Sjp161948
23*2175Sjp161948The size in bytes.
24*2175Sjp161948
25*2175Sjp161948=head1 SEE ALSO
26*2175Sjp161948
27*2175Sjp161948L<dh(3)|dh(3)>, L<DH_generate_key(3)|DH_generate_key(3)>
28*2175Sjp161948
29*2175Sjp161948=head1 HISTORY
30*2175Sjp161948
31*2175Sjp161948DH_size() is available in all versions of SSLeay and OpenSSL.
32*2175Sjp161948
33*2175Sjp161948=cut
34