From ed2eafc8652f7ceb1e46ea8b49a2952f794ff139 Mon Sep 17 00:00:00 2001
From: Miod Vallat <miod@cvs.openbsd.org>
Date: Fri, 11 Jul 2014 16:18:15 +0000
Subject: Huge documentation update for libcrypto and libssl, mostly from Matt
 Caswell, Jeff Trawick, Jean-Paul Calderone, Michal Bozon, Jeffrey Walton and
 Rich Salz, via OpenSSL trunk (with some parts not applying to us, such as
 SSLv2 support, at least partially removed).

---
 lib/libcrypto/doc/DH_generate_parameters.pod | 46 ++++++++++++++++------------
 1 file changed, 27 insertions(+), 19 deletions(-)

(limited to 'lib/libcrypto/doc/DH_generate_parameters.pod')

diff --git a/lib/libcrypto/doc/DH_generate_parameters.pod b/lib/libcrypto/doc/DH_generate_parameters.pod
index 3832c25315a..bd0782cb0c5 100644
--- a/lib/libcrypto/doc/DH_generate_parameters.pod
+++ b/lib/libcrypto/doc/DH_generate_parameters.pod
@@ -2,31 +2,37 @@
 
 =head1 NAME
 
-DH_generate_parameters, DH_check - generate and check Diffie-Hellman parameters
+DH_generate_parameters_ex, DH_generate_parameters,
+DH_check - generate and check Diffie-Hellman parameters
 
 =head1 SYNOPSIS
 
  #include <openssl/dh.h>
 
- DH *DH_generate_parameters(int prime_len, int generator,
-     void (*callback)(int, int, void *), void *cb_arg);
+ int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
 
  int DH_check(DH *dh, int *codes);
 
+Deprecated:
+
+ DH *DH_generate_parameters(int prime_len, int generator,
+     void (*callback)(int, int, void *), void *cb_arg);
+
 =head1 DESCRIPTION
 
-DH_generate_parameters() generates Diffie-Hellman parameters that can
-be shared among a group of users, and returns them in a newly
-allocated B<DH> structure.
+DH_generate_parameters_ex() generates Diffie-Hellman parameters that can
+be shared among a group of users, and stores them in the provided B<DH>
+structure.
 
 B<prime_len> is the length in bits of the safe prime to be generated.
 B<generator> is a small number E<gt> 1, typically 2 or 5.
 
-A callback function may be used to provide feedback about the progress of the
-key generation. If B<callback> is not B<NULL>, it will be called as described
-in L<BN_generate_prime(3)|BN_generate_prime(3)> while a random prime number is
-generated, and when a prime has been found, B<callback(3, 0, cb_arg)> is
-called.
+A callback function may be used to provide feedback about the progress
+of the key generation. If B<cb> is not B<NULL>, it will be
+called as described in L<BN_generate_prime(3)|BN_generate_prime(3)> while a random prime number is
+generated, and when a prime has been found, B<BN_GENCB_call(cb, 3, 0)> is
+called. See L<BN_generate_prime(3)|BN_generate_prime(3)> for information on
+the BN_GENCB_call() function.
 
 DH_check() validates Diffie-Hellman parameters. It checks that B<p> is
 a safe prime, and that B<g> is a suitable generator. In the case of an
@@ -37,19 +43,21 @@ checked, i.e. it does not equal 2 or 5.
 
 =head1 RETURN VALUES
 
-DH_generate_parameters() returns a pointer to the DH structure, or
-NULL if the parameter generation fails. The error codes can be
-obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
+DH_generate_parameters_ex() and DH_check() return 1 if the check could be
+performed, 0 otherwise.
+
+DH_generate_parameters() (deprecated) returns a pointer to the DH structure, or
+NULL if the parameter generation fails.
 
-DH_check() returns 1 if the check could be performed, 0 otherwise.
+The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
 
 =head1 NOTES
 
-DH_generate_parameters() may run for several hours before finding a
-suitable prime.
+DH_generate_parameters_ex() and DH_generate_parameters() may run for several
+hours before finding a suitable prime.
 
-The parameters generated by DH_generate_parameters() are not to be
-used in signature schemes.
+The parameters generated by DH_generate_parameters_ex() and DH_generate_parameters()
+are not to be used in signature schemes.
 
 =head1 BUGS
 
-- 
cgit v1.2.3