summaryrefslogtreecommitdiff
path: root/src/lib/libcrypto/doc/dh.pod
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/libcrypto/doc/dh.pod')
-rw-r--r--src/lib/libcrypto/doc/dh.pod31
1 files changed, 20 insertions, 11 deletions
diff --git a/src/lib/libcrypto/doc/dh.pod b/src/lib/libcrypto/doc/dh.pod
index b4be4be405..c3ccd06207 100644
--- a/src/lib/libcrypto/doc/dh.pod
+++ b/src/lib/libcrypto/doc/dh.pod
@@ -12,20 +12,20 @@ dh - Diffie-Hellman key agreement
12 DH * DH_new(void); 12 DH * DH_new(void);
13 void DH_free(DH *dh); 13 void DH_free(DH *dh);
14 14
15 int DH_size(DH *dh); 15 int DH_size(const DH *dh);
16 16
17 DH * DH_generate_parameters(int prime_len, int generator, 17 DH * DH_generate_parameters(int prime_len, int generator,
18 void (*callback)(int, int, void *), void *cb_arg); 18 void (*callback)(int, int, void *), void *cb_arg);
19 int DH_check(DH *dh, int *codes); 19 int DH_check(const DH *dh, int *codes);
20 20
21 int DH_generate_key(DH *dh); 21 int DH_generate_key(DH *dh);
22 int DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh); 22 int DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh);
23 23
24 void DH_set_default_openssl_method(DH_METHOD *meth); 24 void DH_set_default_method(const DH_METHOD *meth);
25 DH_METHOD *DH_get_default_openssl_method(void); 25 const DH_METHOD *DH_get_default_method(void);
26 int DH_set_method(DH *dh, ENGINE *engine); 26 int DH_set_method(DH *dh, const DH_METHOD *meth);
27 DH *DH_new_method(ENGINE *engine); 27 DH *DH_new_method(ENGINE *engine);
28 DH_METHOD *DH_OpenSSL(void); 28 const DH_METHOD *DH_OpenSSL(void);
29 29
30 int DH_get_ex_new_index(long argl, char *argp, int (*new_func)(), 30 int DH_get_ex_new_index(long argl, char *argp, int (*new_func)(),
31 int (*dup_func)(), void (*free_func)()); 31 int (*dup_func)(), void (*free_func)());
@@ -33,10 +33,10 @@ dh - Diffie-Hellman key agreement
33 char *DH_get_ex_data(DH *d, int idx); 33 char *DH_get_ex_data(DH *d, int idx);
34 34
35 DH * d2i_DHparams(DH **a, unsigned char **pp, long length); 35 DH * d2i_DHparams(DH **a, unsigned char **pp, long length);
36 int i2d_DHparams(DH *a, unsigned char **pp); 36 int i2d_DHparams(const DH *a, unsigned char **pp);
37 37
38 int DHparams_print_fp(FILE *fp, DH *x); 38 int DHparams_print_fp(FILE *fp, const DH *x);
39 int DHparams_print(BIO *bp, DH *x); 39 int DHparams_print(BIO *bp, const DH *x);
40 40
41=head1 DESCRIPTION 41=head1 DESCRIPTION
42 42
@@ -57,11 +57,20 @@ The B<DH> structure consists of several BIGNUM components.
57 }; 57 };
58 DH 58 DH
59 59
60Note that DH keys may use non-standard B<DH_METHOD> implementations,
61either directly or by the use of B<ENGINE> modules. In some cases (eg. an
62ENGINE providing support for hardware-embedded keys), these BIGNUM values
63will not be used by the implementation or may be used for alternative data
64storage. For this reason, applications should generally avoid using DH
65structure elements directly and instead use API functions to query or
66modify keys.
67
60=head1 SEE ALSO 68=head1 SEE ALSO
61 69
62L<dhparam(1)|dhparam(1)>, L<bn(3)|bn(3)>, L<dsa(3)|dsa(3)>, L<err(3)|err(3)>, 70L<dhparam(1)|dhparam(1)>, L<bn(3)|bn(3)>, L<dsa(3)|dsa(3)>, L<err(3)|err(3)>,
63L<rand(3)|rand(3)>, L<rsa(3)|rsa(3)>, L<DH_set_method(3)|DH_set_method(3)>, 71L<rand(3)|rand(3)>, L<rsa(3)|rsa(3)>, L<engine(3)|engine(3)>,
64L<DH_new(3)|DH_new(3)>, L<DH_get_ex_new_index(3)|DH_get_ex_new_index(3)>, 72L<DH_set_method(3)|DH_set_method(3)>, L<DH_new(3)|DH_new(3)>,
73L<DH_get_ex_new_index(3)|DH_get_ex_new_index(3)>,
65L<DH_generate_parameters(3)|DH_generate_parameters(3)>, 74L<DH_generate_parameters(3)|DH_generate_parameters(3)>,
66L<DH_compute_key(3)|DH_compute_key(3)>, L<d2i_DHparams(3)|d2i_DHparams(3)>, 75L<DH_compute_key(3)|DH_compute_key(3)>, L<d2i_DHparams(3)|d2i_DHparams(3)>,
67L<RSA_print(3)|RSA_print(3)> 76L<RSA_print(3)|RSA_print(3)>