diff options
Diffstat (limited to 'doc/man3/DH_size.pod')
-rw-r--r-- | doc/man3/DH_size.pod | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/man3/DH_size.pod b/doc/man3/DH_size.pod new file mode 100644 index 0000000000..8c1d151fcf --- /dev/null +++ b/doc/man3/DH_size.pod @@ -0,0 +1,47 @@ +=pod + +=head1 NAME + +DH_size, DH_bits - get Diffie-Hellman prime size + +=head1 SYNOPSIS + +#include <openssl/dh.h> + +int DH_size(const DH *dh); + +int DH_bits(const DH *dh); + +=head1 DESCRIPTION + +DH_size() returns the Diffie-Hellman prime size in bytes. It can be used +to determine how much memory must be allocated for the shared secret +computed by DH_compute_key(). + +DH_bits() returns the number of significant bits. + +B<dh> and B<dh-E<gt>p> must not be B<NULL>. + +=head1 RETURN VALUE + +The size. + +=head1 SEE ALSO + +L<dh(3)>, L<DH_generate_key(3)>, +L<BN_num_bits(3)> + +=head1 HISTORY + +DH_bits() was added in OpenSSL 1.1.0. + +=head1 COPYRIGHT + +Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. + +Licensed under the OpenSSL license (the "License"). You may not use +this file except in compliance with the License. You can obtain a copy +in the file LICENSE in the source distribution or at +L<https://www.openssl.org/source/license.html>. + +=cut |