]> git.ipfire.org Git - thirdparty/openssl.git/commitdiff
doc: add missing DH_check_pub_key documentation and fix typo
authorkovan <xaum.io@gmail.com>
Tue, 27 Jan 2026 05:01:51 +0000 (06:01 +0100)
committerPauli <paul.dale@oracle.com>
Wed, 28 Jan 2026 22:08:14 +0000 (09:08 +1100)
Add DH_check_pub_key to NAME and SYNOPSIS sections. Fix typo where
DH_check_params() was incorrectly written instead of DH_check_params_ex()
in the description of the _ex functions.

Also remove DH_check_pub_key from util/missingcrypto.txt since it is
now documented.

Fixes #8473

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Nikola Pajkovsky <nikolap@openssl.org>
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/29768)

doc/man3/DH_generate_parameters.pod
util/missingcrypto.txt

index e677885597ae6a5a90522c1b5e6dd64769a26b30..1dda2e8510cf3733b1d6299d4a4f48ac986b27b9 100644 (file)
@@ -3,7 +3,7 @@
 =head1 NAME
 
 DH_generate_parameters_ex, DH_generate_parameters,
-DH_check, DH_check_params,
+DH_check, DH_check_params, DH_check_pub_key,
 DH_check_ex, DH_check_params_ex, DH_check_pub_key_ex
 - generate and check Diffie-Hellman
 parameters
@@ -20,6 +20,7 @@ see L<openssl_user_macros(7)>:
 
  int DH_check(DH *dh, int *codes);
  int DH_check_params(DH *dh, int *codes);
+ int DH_check_pub_key(const DH *dh, const BIGNUM *pub_key, int *codes);
 
  int DH_check_ex(const DH *dh);
  int DH_check_params_ex(const DH *dh);
@@ -132,10 +133,10 @@ If 0 is returned or B<*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.
 
-DH_check_ex(), DH_check_params() and DH_check_pub_key_ex() are similar to
-DH_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.
+DH_check_ex(), DH_check_params_ex() and DH_check_pub_key_ex() are similar to
+DH_check(), DH_check_params() and DH_check_pub_key() respectively, but the
+error reasons are added to the thread's error queue instead of provided as
+return values from the function.
 
 =head1 RETURN VALUES
 
index 49765d4f7e625343f406f98520aa75ecec9dc585..b0cc4e9214af2280484333d7c9785332de14311e 100644 (file)
@@ -413,7 +413,6 @@ DES_encrypt2(3)
 DES_encrypt3(3)
 DES_options(3)
 DH_KDF_X9_42(3)
-DH_check_pub_key(3)
 DH_up_ref(3)
 DHparams_dup(3)
 DHparams_it(3)