openssl-cmake/doc/man3/DH_size.pod

58 lines
1.3 KiB
Plaintext
Raw Permalink Normal View History

2018-09-04 21:04:43 +02:00
=pod
=head1 NAME
2018-10-18 12:10:39 +02:00
DH_size, DH_bits, DH_security_bits - get Diffie-Hellman prime size and
security bits
2018-09-04 21:04:43 +02:00
=head1 SYNOPSIS
2018-10-18 12:10:39 +02:00
#include <openssl/dh.h>
2018-09-04 21:04:43 +02:00
2018-10-18 12:10:39 +02:00
int DH_size(const DH *dh);
2018-09-04 21:04:43 +02:00
2018-10-18 12:10:39 +02:00
int DH_bits(const DH *dh);
int DH_security_bits(const DH *dh);
2018-09-04 21:04:43 +02:00
=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
2018-10-18 12:10:39 +02:00
computed by L<DH_compute_key(3)>.
2018-09-04 21:04:43 +02:00
DH_bits() returns the number of significant bits.
B<dh> and B<dh-E<gt>p> must not be B<NULL>.
2018-10-18 12:10:39 +02:00
DH_security_bits() returns the number of security bits of the given B<dh>
key. See L<BN_security_bits(3)>.
=head1 RETURN VALUES
DH_size() returns the prime size of Diffie-Hellman in bytes.
DH_bits() returns the number of bits in the key.
2018-09-04 21:04:43 +02:00
2018-10-18 12:10:39 +02:00
DH_security_bits() returns the number of security bits.
2018-09-04 21:04:43 +02:00
=head1 SEE ALSO
2018-10-18 12:10:39 +02:00
L<DH_new(3)>, L<DH_generate_key(3)>,
2018-09-04 21:04:43 +02:00
L<BN_num_bits(3)>
=head1 HISTORY
2019-05-09 09:34:00 +02:00
The DH_bits() function was added in OpenSSL 1.1.0.
2018-09-04 21:04:43 +02:00
=head1 COPYRIGHT
2018-10-18 12:10:39 +02:00
Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
2018-09-04 21:04:43 +02:00
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