xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/DH_size.3 (revision 7d9ffdb3e9da593a05c5e2169f72fc7bada08bc9)
$NetBSD: DH_size.3,v 1.25 2024/09/08 13:08:18 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "DH_size 3"
DH_size 3 2024-09-03 3.0.15 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
DH_size, DH_bits, DH_security_bits - get Diffie-Hellman prime size and security bits
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/dh.h> .Ve

The following functions have been deprecated since OpenSSL 3.0, and can be hidden entirely by defining OPENSSL_API_COMPAT with a suitable version value, see openssl_user_macros\|(7):

.Vb 1 int DH_bits(const DH *dh); \& int DH_size(const DH *dh); \& int DH_security_bits(const DH *dh); .Ve

DESCRIPTION
Header "DESCRIPTION" The functions described on this page are deprecated. Applications should instead use EVP_PKEY_get_bits\|(3), \fBEVP_PKEY_get_security_bits\|(3) and EVP_PKEY_get_size\|(3).

\fBDH_bits() returns the number of significant bits.

\fBdh and dh->p must not be NULL.

\fBDH_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\|(3).

\fBDH_security_bits() returns the number of security bits of the given dh key. See BN_security_bits\|(3).

"RETURN VALUES"
Header "RETURN VALUES" \fBDH_bits() returns the number of bits in the key, or -1 if \fBdh doesn't hold any key parameters.

\fBDH_size() returns the prime size of Diffie-Hellman in bytes, or -1 if \fBdh doesn't hold any key parameters.

\fBDH_security_bits() returns the number of security bits, or -1 if \fBdh doesn't hold any key parameters.

"SEE ALSO"
Header "SEE ALSO" \fBEVP_PKEY_get_bits\|(3), \fBDH_new\|(3), DH_generate_key\|(3), \fBBN_num_bits\|(3)
HISTORY
Header "HISTORY" All functions were deprecated in OpenSSL 3.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (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 <https://www.openssl.org/source/license.html>.