diff options
Diffstat (limited to 'src/lib/libcrypto/doc/DH_size.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/DH_size.pod | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/src/lib/libcrypto/doc/DH_size.pod b/src/lib/libcrypto/doc/DH_size.pod new file mode 100644 index 0000000000..97f26fda78 --- /dev/null +++ b/src/lib/libcrypto/doc/DH_size.pod | |||
| @@ -0,0 +1,33 @@ | |||
| 1 | =pod | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | DH_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 | |||
| 15 | This function returns the Diffie-Hellman size in bytes. It can be used | ||
| 16 | to determine how much memory must be allocated for the shared secret | ||
| 17 | computed by DH_compute_key(). | ||
| 18 | |||
| 19 | B<dh-E<gt>p> must not be B<NULL>. | ||
| 20 | |||
| 21 | =head1 RETURN VALUE | ||
| 22 | |||
| 23 | The size in bytes. | ||
| 24 | |||
| 25 | =head1 SEE ALSO | ||
| 26 | |||
| 27 | L<dh(3)|dh(3)>, L<DH_generate_key(3)|DH_generate_key(3)> | ||
| 28 | |||
| 29 | =head1 HISTORY | ||
| 30 | |||
| 31 | DH_size() is available in all versions of SSLeay and OpenSSL. | ||
| 32 | |||
| 33 | =cut | ||
