$NetBSD: DH_generate_parameters.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_generate_parameters 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
DH_generate_parameters_ex, DH_generate_parameters, DH_check, DH_check_params, DH_check_ex, DH_check_params_ex, DH_check_pub_key_ex \- generate and check Diffie-Hellman parameters 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_generate_parameters_ex(DH *dh, int prime_len, int generator, BN_GENCB *cb); \& int DH_check(DH *dh, int *codes); int DH_check_params(DH *dh, int *codes); \& int DH_check_ex(const DH *dh); int DH_check_params_ex(const DH *dh); int DH_check_pub_key_ex(const DH *dh, const BIGNUM *pub_key); .Ve

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

.Vb 2 DH *DH_generate_parameters(int prime_len, int generator, void (*callback)(int, int, void *), void *cb_arg); .Ve

Header "DESCRIPTION" All of the functions described on this page are deprecated. Applications should instead use EVP_PKEY_check\|(3), \fBEVP_PKEY_public_check\|(3), EVP_PKEY_private_check\|(3) and \fBEVP_PKEY_param_check\|(3).

\fBDH_generate_parameters_ex() generates Diffie-Hellman parameters that can be shared among a group of users, and stores them in the provided DH structure. The pseudo-random number generator must be seeded before calling it. The parameters generated by DH_generate_parameters_ex() should not be used in signature schemes.

\fBprime_len is the length in bits of the safe prime to be generated. \fBgenerator is a small number > 1, typically 2 or 5.

A callback function may be used to provide feedback about the progress of the key generation. If cb is not NULL, it will be called as described in BN_generate_prime\|(3) while a random prime number is generated, and when a prime has been found, BN_GENCB_call(cb, 3, 0) is called. See BN_generate_prime_ex\|(3) for information on the BN_GENCB_call() function.

\fBDH_generate_parameters() is similar to DH_generate_prime_ex() but expects an old-style callback function; see \fBBN_generate_prime\|(3) for information on the old-style callback.

\fBDH_check_params() confirms that the p and g are likely enough to be valid. This is a lightweight check, if a more thorough check is needed, use \fBDH_check(). The value of *codes is updated with any problems found. If *codes is zero then no problems were found, otherwise the following bits may be set:

Item "DH_CHECK_P_NOT_PRIME" The parameter p has been determined to not being an odd prime. Note that the lack of this bit doesn't guarantee that p is a prime. Item "DH_NOT_SUITABLE_GENERATOR" The generator g is not suitable. Note that the lack of this bit doesn't guarantee that g is suitable, unless p is known to be a strong prime. Item "DH_MODULUS_TOO_SMALL" The modulus is too small. Item "DH_MODULUS_TOO_LARGE" The modulus is too large.

\fBDH_check() confirms that the Diffie-Hellman parameters dh are valid. The value of *codes is updated with any problems found. If *codes is zero then no problems were found, otherwise the following bits may be set:

Item "DH_CHECK_P_NOT_PRIME" The parameter p is not prime. Item "DH_CHECK_P_NOT_SAFE_PRIME" The parameter p is not a safe prime and no q value is present. Item "DH_UNABLE_TO_CHECK_GENERATOR" The generator g cannot be checked for suitability. Item "DH_NOT_SUITABLE_GENERATOR" The generator g is not suitable. Item "DH_CHECK_Q_NOT_PRIME" The parameter q is not prime. Item "DH_CHECK_INVALID_Q_VALUE" The parameter q is invalid. Item "DH_CHECK_INVALID_J_VALUE" The parameter j is invalid.

If 0 is returned or *codes is set to a nonzero value the supplied parameters should not be used for Diffie-Hellman operations otherwise the security properties of the key exchange are not guaranteed.

\fBDH_check_ex(), DH_check_params() and DH_check_pub_key_ex() are similar to \fBDH_check() and DH_check_params() respectively, but the error reasons are added to the thread's error queue instead of provided as return values from the function.

Header "RETURN VALUES" \fBDH_generate_parameters_ex(), DH_check() and DH_check_params() return 1 if the check could be performed, 0 otherwise.

\fBDH_generate_parameters() returns a pointer to the DH structure or NULL if the parameter generation fails.

\fBDH_check_ex(), DH_check_params() and DH_check_pub_key_ex() return 1 if the check is successful, 0 for failed.

The error codes can be obtained by ERR_get_error\|(3).

Header "SEE ALSO" \fBDH_new\|(3), ERR_get_error\|(3), RAND_bytes\|(3), \fBDH_free\|(3) Header "HISTORY" All of these functions were deprecated in OpenSSL 3.0.

\fBDH_generate_parameters() was deprecated in OpenSSL 0.9.8; use \fBDH_generate_parameters_ex() instead.

Header "COPYRIGHT" Copyright 2000-2023 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>.