doc/man3/DH_size.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 DH_size, DH_bits, DH_security_bits - get Diffie-Hellman prime size and
   6 security bits
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/dh.h>
  11
  12  int DH_bits(const DH *dh);
  13
  14 Deprecated since OpenSSL 3.0, can be hidden entirely by defining
  15 B<OPENSSL_API_COMPAT> with a suitable version value, see
  16 L<openssl_user_macros(7)>:
  17
  18  int DH_size(const DH *dh);
  19
  20  int DH_security_bits(const DH *dh);
  21
  22 =head1 DESCRIPTION
  23
  24 DH_bits() returns the number of significant bits.
  25
  26 B<dh> and B<dh-E<gt>p> must not be B<NULL>.
  27
  28 The remaining functions described on this page are deprecated.
  29 Applications should instead use L<EVP_PKEY_security_bits(3)> and
  30 L<EVP_PKEY_size(3)>.
  31
  32 DH_size() returns the Diffie-Hellman prime size in bytes. It can be used
  33 to determine how much memory must be allocated for the shared secret
  34 computed by L<DH_compute_key(3)>.
  35
  36 DH_security_bits() returns the number of security bits of the given B<dh>
  37 key. See L<BN_security_bits(3)>.
  38
  39 =head1 RETURN VALUES
  40
  41 DH_bits() returns the number of bits in the key, or -1 if
  42 B<dh> doesn't hold any key parameters.
  43
  44 DH_size() returns the prime size of Diffie-Hellman in bytes, or -1 if
  45 B<dh> doesn't hold any key parameters.
  46
  47 DH_security_bits() returns the number of security bits, or -1 if
  48 B<dh> doesn't hold any key parameters.
  49
  50 =head1 SEE ALSO
  51
  52 L<EVP_PKEY_bits(3)>,
  53 L<DH_new(3)>, L<DH_generate_key(3)>,
  54 L<BN_num_bits(3)>
  55
  56 =head1 HISTORY
  57
  58 The DH_size() and DH_security_bits() functions were deprecated in OpenSSL 3.0.
  59
  60 The DH_bits() function was added in OpenSSL 1.1.0.
  61
  62 =head1 COPYRIGHT
  63
  64 Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
  65
  66 Licensed under the Apache License 2.0 (the "License").  You may not use
  67 this file except in compliance with the License.  You can obtain a copy
  68 in the file LICENSE in the source distribution or at
  69 L<https://www.openssl.org/source/license.html>.
  70
  71 =cut