Less documentation for deprecated API
[openssl.git] / doc / man3 / DH_generate_parameters.pod
index ce178af..4143df0 100644 (file)
@@ -19,7 +19,7 @@ Deprecated:
 
  #if OPENSSL_API_COMPAT < 0x00908000L
  DH *DH_generate_parameters(int prime_len, int generator,
-     void (*callback)(int, int, void *), void *cb_arg);
+                            void (*callback)(int, int, void *), void *cb_arg);
  #endif
 
 =head1 DESCRIPTION
@@ -27,7 +27,9 @@ Deprecated:
 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. The pseudo-random number generator must be
-seeded prior to calling DH_generate_parameters().
+seeded before calling it.
+The parameters generated by DH_generate_parameters_ex() should not be used in
+signature schemes.
 
 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.
@@ -36,9 +38,13 @@ 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)> 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)> for information on
+is called. See L<BN_generate_prime_ex(3)> for information on
 the BN_GENCB_call() function.
 
+DH_generate_parameters() is similar to DH_generate_prime_ex() but
+expects an old-style callback function; see
+L<BN_generate_prime(3)> for information on the old-style callback.
+
 DH_check_params() confirms that the B<p> and B<g> are likely enough to
 be valid.
 This is a lightweight check, if a more thorough check is needed, use
@@ -104,24 +110,21 @@ The parameter B<j> is invalid.
 DH_generate_parameters_ex(), DH_check() and DH_check_params() 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_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)>.
 
-=head1 NOTES
-
-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_ex() and DH_generate_parameters()
-are not to be used in signature schemes.
-
 =head1 SEE ALSO
 
 L<DH_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>,
 L<DH_free(3)>
 
+=head1 HISTORY
+
+DH_generate_parameters() was deprecated in OpenSSL version 0.9.8; use
+DH_generate_parameters_ex() instead.
+
 =head1 COPYRIGHT
 
 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.