summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/DH_generate_parameters.pod
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/doc/DH_generate_parameters.pod')
-rw-r--r--src/lib/libcrypto/doc/DH_generate_parameters.pod46
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
5DH_generate_parameters, DH_check - generate and check Diffie-Hellman parameters 5DH_generate_parameters_ex, DH_generate_parameters,
6DH_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
16Deprecated:
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
18DH_generate_parameters() generates Diffie-Hellman parameters that can 23DH_generate_parameters_ex() generates Diffie-Hellman parameters that can
19be shared among a group of users, and returns them in a newly 24be shared among a group of users, and stores them in the provided B<DH>
20allocated B<DH> structure. 25structure.
21 26
22B<prime_len> is the length in bits of the safe prime to be generated. 27B<prime_len> is the length in bits of the safe prime to be generated.
23B<generator> is a small number E<gt> 1, typically 2 or 5. 28B<generator> is a small number E<gt> 1, typically 2 or 5.
24 29
25A callback function may be used to provide feedback about the progress of the 30A callback function may be used to provide feedback about the progress
26key generation. If B<callback> is not B<NULL>, it will be called as described 31of the key generation. If B<cb> is not B<NULL>, it will be
27in L<BN_generate_prime(3)|BN_generate_prime(3)> while a random prime number is 32called as described in L<BN_generate_prime(3)|BN_generate_prime(3)> while a random prime number is
28generated, and when a prime has been found, B<callback(3, 0, cb_arg)> is 33generated, and when a prime has been found, B<BN_GENCB_call(cb, 3, 0)> is
29called. 34called. See L<BN_generate_prime(3)|BN_generate_prime(3)> for information on
35the BN_GENCB_call() function.
30 36
31DH_check() validates Diffie-Hellman parameters. It checks that B<p> is 37DH_check() validates Diffie-Hellman parameters. It checks that B<p> is
32a safe prime, and that B<g> is a suitable generator. In the case of an 38a 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
40DH_generate_parameters() returns a pointer to the DH structure, or 46DH_generate_parameters_ex() and DH_check() return 1 if the check could be
41NULL if the parameter generation fails. The error codes can be 47performed, 0 otherwise.
42obtained by L<ERR_get_error(3)|ERR_get_error(3)>. 48
49DH_generate_parameters() (deprecated) returns a pointer to the DH structure, or
50NULL if the parameter generation fails.
43 51
44DH_check() returns 1 if the check could be performed, 0 otherwise. 52The 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
48DH_generate_parameters() may run for several hours before finding a 56DH_generate_parameters_ex() and DH_generate_parameters() may run for several
49suitable prime. 57hours before finding a suitable prime.
50 58
51The parameters generated by DH_generate_parameters() are not to be 59The parameters generated by DH_generate_parameters_ex() and DH_generate_parameters()
52used in signature schemes. 60are not to be used in signature schemes.
53 61
54=head1 BUGS 62=head1 BUGS
55 63