summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/DH_generate_parameters.pod
diff options
context:
space:
mode:
authorschwarze <>2016-11-02 09:11:53 +0000
committerschwarze <>2016-11-02 09:11:53 +0000
commitb50ac7faef96a45291b0c3201b82185f7579e826 (patch)
tree9166b196a2c833fc7a0154973d11551824a6bfb9 /src/lib/libcrypto/doc/DH_generate_parameters.pod
parent506350d1237710b9d86fdb3a794c6e6265f71221 (diff)
downloadopenbsd-b50ac7faef96a45291b0c3201b82185f7579e826.tar.gz
openbsd-b50ac7faef96a45291b0c3201b82185f7579e826.tar.bz2
openbsd-b50ac7faef96a45291b0c3201b82185f7579e826.zip
convert DES and DH manuals from pod to mdoc
Diffstat (limited to 'src/lib/libcrypto/doc/DH_generate_parameters.pod')
-rw-r--r--src/lib/libcrypto/doc/DH_generate_parameters.pod80
1 files changed, 0 insertions, 80 deletions
diff --git a/src/lib/libcrypto/doc/DH_generate_parameters.pod b/src/lib/libcrypto/doc/DH_generate_parameters.pod
deleted file mode 100644
index bd0782cb0c..0000000000
--- a/src/lib/libcrypto/doc/DH_generate_parameters.pod
+++ /dev/null
@@ -1,80 +0,0 @@
1=pod
2
3=head1 NAME
4
5DH_generate_parameters_ex, DH_generate_parameters,
6DH_check - generate and check Diffie-Hellman parameters
7
8=head1 SYNOPSIS
9
10 #include <openssl/dh.h>
11
12 int DH_generate_parameters_ex(DH *dh, int prime_len,int generator, BN_GENCB *cb);
13
14 int DH_check(DH *dh, int *codes);
15
16Deprecated:
17
18 DH *DH_generate_parameters(int prime_len, int generator,
19 void (*callback)(int, int, void *), void *cb_arg);
20
21=head1 DESCRIPTION
22
23DH_generate_parameters_ex() generates Diffie-Hellman parameters that can
24be shared among a group of users, and stores them in the provided B<DH>
25structure.
26
27B<prime_len> is the length in bits of the safe prime to be generated.
28B<generator> is a small number E<gt> 1, typically 2 or 5.
29
30A callback function may be used to provide feedback about the progress
31of the key generation. If B<cb> is not B<NULL>, it will be
32called as described in L<BN_generate_prime(3)|BN_generate_prime(3)> while a random prime number is
33generated, and when a prime has been found, B<BN_GENCB_call(cb, 3, 0)> is
34called. See L<BN_generate_prime(3)|BN_generate_prime(3)> for information on
35the BN_GENCB_call() function.
36
37DH_check() validates Diffie-Hellman parameters. It checks that B<p> is
38a safe prime, and that B<g> is a suitable generator. In the case of an
39error, the bit flags DH_CHECK_P_NOT_SAFE_PRIME or
40DH_NOT_SUITABLE_GENERATOR are set in B<*codes>.
41DH_UNABLE_TO_CHECK_GENERATOR is set if the generator cannot be
42checked, i.e. it does not equal 2 or 5.
43
44=head1 RETURN VALUES
45
46DH_generate_parameters_ex() and DH_check() return 1 if the check could be
47performed, 0 otherwise.
48
49DH_generate_parameters() (deprecated) returns a pointer to the DH structure, or
50NULL if the parameter generation fails.
51
52The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
53
54=head1 NOTES
55
56DH_generate_parameters_ex() and DH_generate_parameters() may run for several
57hours before finding a suitable prime.
58
59The parameters generated by DH_generate_parameters_ex() and DH_generate_parameters()
60are not to be used in signature schemes.
61
62=head1 BUGS
63
64If B<generator> is not 2 or 5, B<dh-E<gt>g>=B<generator> is not
65a usable generator.
66
67=head1 SEE ALSO
68
69L<dh(3)|dh(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<rand(3)|rand(3)>,
70L<DH_free(3)|DH_free(3)>
71
72=head1 HISTORY
73
74DH_check() is available in all versions of SSLeay and OpenSSL.
75The B<cb_arg> argument to DH_generate_parameters() was added in SSLeay 0.9.0.
76
77In versions before OpenSSL 0.9.5, DH_CHECK_P_NOT_STRONG_PRIME is used
78instead of DH_CHECK_P_NOT_SAFE_PRIME.
79
80=cut