wbrawner/openssl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
openssl/doc/man3/DH_generate_parameters.pod

109 lines
2.9 KiB
Text
Raw Normal View History

Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
=pod
=head1 NAME
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
DH_generate_parameters_ex, DH_generate_parameters,
DH_check - generate and check Diffie-Hellman parameters
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
=head1 SYNOPSIS
#include <openssl/dh.h>
RT4593: Add space after comma (doc nits) Update find-doc-nits to find errors in SYNOPSIS (the most common place where they were missing). Reviewed-by: Matt Caswell <matt@openssl.org>
2016-07-19 13:27:53 +00:00
int DH_generate_parameters_ex(DH *dh, int prime_len, int generator, BN_GENCB *cb);
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
int DH_check(DH *dh, int *codes);
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
Deprecated:
Backwards-compatibility subject to OPENSSL_API_COMPAT Provide backwards-compatiblity for functions, macros and include files if OPENSSL_API_COMPAT is either not defined or defined less than the version number of the release in which the feature was deprecated. Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-01-05 04:00:33 +00:00
#if OPENSSL_API_COMPAT < 0x00908000L
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
DH *DH_generate_parameters(int prime_len, int generator,
void (*callback)(int, int, void *), void *cb_arg);
Backwards-compatibility subject to OPENSSL_API_COMPAT Provide backwards-compatiblity for functions, macros and include files if OPENSSL_API_COMPAT is either not defined or defined less than the version number of the release in which the feature was deprecated. Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-01-05 04:00:33 +00:00
#endif
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
=head1 DESCRIPTION
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
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
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
seeded prior to calling DH_generate_parameters().
B<prime_len> is the length in bits of the safe prime to be generated.
Fix nits in pod files. Add doc-nit-check to help find future issues. Make podchecker be almost clean. Remove trailing whitespace. Tab expansion Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-20 12:11:46 +00:00
B<generator> is a small number E<gt> 1, typically 2 or 5.
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
A callback function may be used to provide feedback about the progress
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
of the key generation. If B<cb> is not B<NULL>, it will be
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-17 19:21:33 +00:00
called as described in L<BN_generate_prime(3)> while a random prime
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
number is generated, and when a prime has been found, B<BN_GENCB_call(cb, 3, 0)>
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-17 19:21:33 +00:00
is called. See L<BN_generate_prime(3)> for information on
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
the BN_GENCB_call() function.
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
Add dhparam sanity check and update DH_check documentation The -check argument to dhparam should never identify any problems if we have just generated the parameters. Add a sanity check for this and print an error and fail if necessary. Also updates the documentation for the -check argument, and the DH_check() function. RT#4244 Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-27 12:26:03 +00:00
DH_check() confirms that the Diffie-Hellman parameters B<dh> are valid. The
value of B<*codes> is updated with any problems found. If B<*codes> is zero then
no problems were found, otherwise the following bits may be set:
=over 4
=item DH_CHECK_P_NOT_PRIME
The parameter B<p> is not prime.
=item DH_CHECK_P_NOT_SAFE_PRIME
The parameter B<p> is not a safe prime and no B<q> value is present.
=item DH_UNABLE_TO_CHECK_GENERATOR
The generator B<g> cannot be checked for suitability.
=item DH_NOT_SUITABLE_GENERATOR
The generator B<g> is not suitable.
=item DH_CHECK_Q_NOT_PRIME
The parameter B<q> is not prime.
=item DH_CHECK_INVALID_Q_VALUE
The parameter B<q> is invalid.
=item DH_CHECK_INVALID_J_VALUE
The parameter B<j> is invalid.
=back
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
=head1 RETURN VALUES
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
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.
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-17 19:21:33 +00:00
The error codes can be obtained by L<ERR_get_error(3)>.
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
=head1 NOTES
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
DH_generate_parameters_ex() and DH_generate_parameters() may run for several
hours before finding a suitable prime.
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
Document updates from wiki. PR#3071 The primary changes made are: - Updates to the "NAME" section of many pages to correctly reflect the functions defined on those pages. This section is automatically parsed by the util/extract-names.pl script, so if it is not correct then running "man" will not correctly locate the right manual pages. - Updates to take account of where functions are now deprecated - Full documentation of the ec sub-library - A number of other typo corrections and other minor tweaks
2013-06-12 22:42:08 +00:00
The parameters generated by DH_generate_parameters_ex() and DH_generate_parameters()
are not to be used in signature schemes.
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
=head1 SEE ALSO
Fix referenses in section 3 manuals Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1900)
2016-11-11 08:33:09 +00:00
L<DH_new(3)>, L<ERR_get_error(3)>, L<RAND_bytes(3)>,
Fix L<> content in manpages L<foo|foo> is sub-optimal If the xref is the same as the title, which is what we do, then you only need L<foo>. This fixes all 1457 occurrences in 349 files. Approximately. (And pod used to need both.) Reviewed-by: Richard Levitte <levitte@openssl.org>
2015-08-17 19:21:33 +00:00
L<DH_free(3)>
Document the DH library, and make some minor changes along the way.
2000-01-22 20:05:23 +00:00
Add copyright to manpages Reviewed-by: Richard Levitte <levitte@openssl.org>
2016-05-18 15:44:05 +00:00
=head1 COPYRIGHT
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the OpenSSL license (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
L<https://www.openssl.org/source/license.html>.
=cut
Reference in a new issue Copy permalink