diff options
Diffstat (limited to 'src/lib/libcrypto/doc/DH_generate_parameters.pod')
| -rw-r--r-- | src/lib/libcrypto/doc/DH_generate_parameters.pod | 46 |
1 files changed, 27 insertions, 19 deletions
diff --git a/src/lib/libcrypto/doc/DH_generate_parameters.pod b/src/lib/libcrypto/doc/DH_generate_parameters.pod index 3832c25315..bd0782cb0c 100644 --- a/src/lib/libcrypto/doc/DH_generate_parameters.pod +++ b/src/lib/libcrypto/doc/DH_generate_parameters.pod | |||
| @@ -2,31 +2,37 @@ | |||
| 2 | 2 | ||
| 3 | =head1 NAME | 3 | =head1 NAME |
| 4 | 4 | ||
| 5 | DH_generate_parameters, DH_check - generate and check Diffie-Hellman parameters | 5 | DH_generate_parameters_ex, DH_generate_parameters, |
| 6 | DH_check - generate and check Diffie-Hellman parameters | ||
| 6 | 7 | ||
| 7 | =head1 SYNOPSIS | 8 | =head1 SYNOPSIS |
| 8 | 9 | ||
| 9 | #include <openssl/dh.h> | 10 | #include <openssl/dh.h> |
| 10 | 11 | ||
| 11 | DH *DH_generate_parameters(int prime_len, int generator, | 12 | int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb); |
| 12 | void (*callback)(int, int, void *), void *cb_arg); | ||
| 13 | 13 | ||
| 14 | int DH_check(DH *dh, int *codes); | 14 | int DH_check(DH *dh, int *codes); |
| 15 | 15 | ||
| 16 | Deprecated: | ||
| 17 | |||
| 18 | DH *DH_generate_parameters(int prime_len, int generator, | ||
| 19 | void (*callback)(int, int, void *), void *cb_arg); | ||
| 20 | |||
| 16 | =head1 DESCRIPTION | 21 | =head1 DESCRIPTION |
| 17 | 22 | ||
| 18 | DH_generate_parameters() generates Diffie-Hellman parameters that can | 23 | DH_generate_parameters_ex() generates Diffie-Hellman parameters that can |
| 19 | be shared among a group of users, and returns them in a newly | 24 | be shared among a group of users, and stores them in the provided B<DH> |
| 20 | allocated B<DH> structure. | 25 | structure. |
| 21 | 26 | ||
| 22 | B<prime_len> is the length in bits of the safe prime to be generated. | 27 | B<prime_len> is the length in bits of the safe prime to be generated. |
| 23 | B<generator> is a small number E<gt> 1, typically 2 or 5. | 28 | B<generator> is a small number E<gt> 1, typically 2 or 5. |
| 24 | 29 | ||
| 25 | A callback function may be used to provide feedback about the progress of the | 30 | A callback function may be used to provide feedback about the progress |
| 26 | key generation. If B<callback> is not B<NULL>, it will be called as described | 31 | of the key generation. If B<cb> is not B<NULL>, it will be |
| 27 | in L<BN_generate_prime(3)|BN_generate_prime(3)> while a random prime number is | 32 | called as described in L<BN_generate_prime(3)|BN_generate_prime(3)> while a random prime number is |
| 28 | generated, and when a prime has been found, B<callback(3, 0, cb_arg)> is | 33 | generated, and when a prime has been found, B<BN_GENCB_call(cb, 3, 0)> is |
| 29 | called. | 34 | called. See L<BN_generate_prime(3)|BN_generate_prime(3)> for information on |
| 35 | the BN_GENCB_call() function. | ||
| 30 | 36 | ||
| 31 | DH_check() validates Diffie-Hellman parameters. It checks that B<p> is | 37 | DH_check() validates Diffie-Hellman parameters. It checks that B<p> is |
| 32 | a safe prime, and that B<g> is a suitable generator. In the case of an | 38 | 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. | |||
| 37 | 43 | ||
| 38 | =head1 RETURN VALUES | 44 | =head1 RETURN VALUES |
| 39 | 45 | ||
| 40 | DH_generate_parameters() returns a pointer to the DH structure, or | 46 | DH_generate_parameters_ex() and DH_check() return 1 if the check could be |
| 41 | NULL if the parameter generation fails. The error codes can be | 47 | performed, 0 otherwise. |
| 42 | obtained by L<ERR_get_error(3)|ERR_get_error(3)>. | 48 | |
| 49 | DH_generate_parameters() (deprecated) returns a pointer to the DH structure, or | ||
| 50 | NULL if the parameter generation fails. | ||
| 43 | 51 | ||
| 44 | DH_check() returns 1 if the check could be performed, 0 otherwise. | 52 | The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. |
| 45 | 53 | ||
| 46 | =head1 NOTES | 54 | =head1 NOTES |
| 47 | 55 | ||
| 48 | DH_generate_parameters() may run for several hours before finding a | 56 | DH_generate_parameters_ex() and DH_generate_parameters() may run for several |
| 49 | suitable prime. | 57 | hours before finding a suitable prime. |
| 50 | 58 | ||
| 51 | The parameters generated by DH_generate_parameters() are not to be | 59 | The parameters generated by DH_generate_parameters_ex() and DH_generate_parameters() |
| 52 | used in signature schemes. | 60 | are not to be used in signature schemes. |
| 53 | 61 | ||
| 54 | =head1 BUGS | 62 | =head1 BUGS |
| 55 | 63 | ||
