2000-01-23 04:05:23 +08:00
|
|
|
=pod
|
|
|
|
|
|
|
|
=head1 NAME
|
|
|
|
|
2017-08-09 23:25:19 +08:00
|
|
|
DH_size, DH_bits, DH_security_bits - get Diffie-Hellman prime size and
|
|
|
|
security bits
|
2000-01-23 04:05:23 +08:00
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
2017-08-09 23:25:19 +08:00
|
|
|
#include <openssl/dh.h>
|
2000-01-23 04:05:23 +08:00
|
|
|
|
2020-02-03 17:05:31 +08:00
|
|
|
Deprecated since OpenSSL 3.0, can be hidden entirely by defining
|
|
|
|
B<OPENSSL_API_COMPAT> with a suitable version value, see
|
|
|
|
L<openssl_user_macros(7)>:
|
|
|
|
|
2021-03-28 15:22:40 +08:00
|
|
|
int DH_bits(const DH *dh);
|
|
|
|
|
2017-08-09 23:25:19 +08:00
|
|
|
int DH_size(const DH *dh);
|
2015-04-18 18:23:12 +08:00
|
|
|
|
2017-08-09 23:25:19 +08:00
|
|
|
int DH_security_bits(const DH *dh);
|
2000-01-23 04:05:23 +08:00
|
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
2021-03-28 15:22:40 +08:00
|
|
|
The functions described on this page are deprecated.
|
Rename all getters to use get/get0 in name
For functions that exist in 1.1.1 provide a simple aliases via #define.
Fixes #15236
Functions with OSSL_DECODER_, OSSL_ENCODER_, OSSL_STORE_LOADER_,
EVP_KEYEXCH_, EVP_KEM_, EVP_ASYM_CIPHER_, EVP_SIGNATURE_,
EVP_KEYMGMT_, EVP_RAND_, EVP_MAC_, EVP_KDF_, EVP_PKEY_,
EVP_MD_, and EVP_CIPHER_ prefixes are renamed.
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15405)
2021-05-21 22:58:08 +08:00
|
|
|
Applications should instead use L<EVP_PKEY_get_bits(3)>,
|
|
|
|
L<EVP_PKEY_get_security_bits(3)> and L<EVP_PKEY_get_size(3)>.
|
2021-03-28 15:22:40 +08:00
|
|
|
|
2020-04-28 17:03:05 +08:00
|
|
|
DH_bits() returns the number of significant bits.
|
|
|
|
|
|
|
|
B<dh> and B<dh-E<gt>p> must not be B<NULL>.
|
|
|
|
|
2015-04-18 18:23:12 +08:00
|
|
|
DH_size() returns the Diffie-Hellman prime size in bytes. It can be used
|
2000-01-23 04:05:23 +08:00
|
|
|
to determine how much memory must be allocated for the shared secret
|
2017-08-09 23:25:19 +08:00
|
|
|
computed by L<DH_compute_key(3)>.
|
2000-01-23 04:05:23 +08:00
|
|
|
|
2017-08-09 23:25:19 +08:00
|
|
|
DH_security_bits() returns the number of security bits of the given B<dh>
|
|
|
|
key. See L<BN_security_bits(3)>.
|
|
|
|
|
2017-12-25 17:50:39 +08:00
|
|
|
=head1 RETURN VALUES
|
2000-01-23 04:05:23 +08:00
|
|
|
|
2021-01-25 21:44:29 +08:00
|
|
|
DH_bits() returns the number of bits in the key, or -1 if
|
|
|
|
B<dh> doesn't hold any key parameters.
|
2017-08-09 23:25:19 +08:00
|
|
|
|
2021-01-25 21:44:29 +08:00
|
|
|
DH_size() returns the prime size of Diffie-Hellman in bytes, or -1 if
|
|
|
|
B<dh> doesn't hold any key parameters.
|
2020-04-28 17:03:05 +08:00
|
|
|
|
2021-01-25 21:44:29 +08:00
|
|
|
DH_security_bits() returns the number of security bits, or -1 if
|
|
|
|
B<dh> doesn't hold any key parameters.
|
2000-01-23 04:05:23 +08:00
|
|
|
|
|
|
|
=head1 SEE ALSO
|
|
|
|
|
Rename all getters to use get/get0 in name
For functions that exist in 1.1.1 provide a simple aliases via #define.
Fixes #15236
Functions with OSSL_DECODER_, OSSL_ENCODER_, OSSL_STORE_LOADER_,
EVP_KEYEXCH_, EVP_KEM_, EVP_ASYM_CIPHER_, EVP_SIGNATURE_,
EVP_KEYMGMT_, EVP_RAND_, EVP_MAC_, EVP_KDF_, EVP_PKEY_,
EVP_MD_, and EVP_CIPHER_ prefixes are renamed.
Reviewed-by: Paul Dale <pauli@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15405)
2021-05-21 22:58:08 +08:00
|
|
|
L<EVP_PKEY_get_bits(3)>,
|
2016-11-11 16:33:09 +08:00
|
|
|
L<DH_new(3)>, L<DH_generate_key(3)>,
|
2015-08-18 03:21:33 +08:00
|
|
|
L<BN_num_bits(3)>
|
2000-01-23 04:05:23 +08:00
|
|
|
|
|
|
|
=head1 HISTORY
|
|
|
|
|
2021-03-28 15:22:40 +08:00
|
|
|
All functions were deprecated in OpenSSL 3.0.
|
2000-01-23 04:05:23 +08:00
|
|
|
|
2016-05-18 23:44:05 +08:00
|
|
|
=head1 COPYRIGHT
|
|
|
|
|
2021-03-11 21:27:36 +08:00
|
|
|
Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
|
2016-05-18 23:44:05 +08:00
|
|
|
|
2018-12-06 21:04:44 +08:00
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
2016-05-18 23:44:05 +08:00
|
|
|
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
|