summaryrefslogtreecommitdiffstats
path: root/secure/lib/libcrypto/man/dh.3
diff options
context:
space:
mode:
Diffstat (limited to 'secure/lib/libcrypto/man/dh.3')
-rw-r--r--secure/lib/libcrypto/man/dh.339
1 files changed, 24 insertions, 15 deletions
diff --git a/secure/lib/libcrypto/man/dh.3 b/secure/lib/libcrypto/man/dh.3
index 31cdc59..3c40e68 100644
--- a/secure/lib/libcrypto/man/dh.3
+++ b/secure/lib/libcrypto/man/dh.3
@@ -1,5 +1,5 @@
.\" Automatically generated by Pod::Man version 1.15
-.\" Tue Jul 30 09:22:03 2002
+.\" Mon Jan 13 19:29:15 2003
.\"
.\" Standard preamble:
.\" ======================================================================
@@ -138,37 +138,38 @@
.\" ======================================================================
.\"
.IX Title "dh 3"
-.TH dh 3 "0.9.6e" "2000-04-13" "OpenSSL"
+.TH dh 3 "0.9.7" "2003-01-13" "OpenSSL"
.UC
.SH "NAME"
dh \- Diffie-Hellman key agreement
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
-.Vb 1
+.Vb 2
\& #include <openssl/dh.h>
+\& #include <openssl/engine.h>
.Ve
.Vb 2
\& DH * DH_new(void);
\& void DH_free(DH *dh);
.Ve
.Vb 1
-\& int DH_size(DH *dh);
+\& int DH_size(const DH *dh);
.Ve
.Vb 3
\& DH * DH_generate_parameters(int prime_len, int generator,
\& void (*callback)(int, int, void *), void *cb_arg);
-\& int DH_check(DH *dh, int *codes);
+\& int DH_check(const DH *dh, int *codes);
.Ve
.Vb 2
\& int DH_generate_key(DH *dh);
\& int DH_compute_key(unsigned char *key, BIGNUM *pub_key, DH *dh);
.Ve
.Vb 5
-\& void DH_set_default_method(DH_METHOD *meth);
-\& DH_METHOD *DH_get_default_method(void);
-\& DH_METHOD *DH_set_method(DH *dh, DH_METHOD *meth);
-\& DH *DH_new_method(DH_METHOD *meth);
-\& DH_METHOD *DH_OpenSSL(void);
+\& void DH_set_default_method(const DH_METHOD *meth);
+\& const DH_METHOD *DH_get_default_method(void);
+\& int DH_set_method(DH *dh, const DH_METHOD *meth);
+\& DH *DH_new_method(ENGINE *engine);
+\& const DH_METHOD *DH_OpenSSL(void);
.Ve
.Vb 4
\& int DH_get_ex_new_index(long argl, char *argp, int (*new_func)(),
@@ -178,11 +179,11 @@ dh \- Diffie-Hellman key agreement
.Ve
.Vb 2
\& DH * d2i_DHparams(DH **a, unsigned char **pp, long length);
-\& int i2d_DHparams(DH *a, unsigned char **pp);
+\& int i2d_DHparams(const DH *a, unsigned char **pp);
.Ve
.Vb 2
-\& int DHparams_print_fp(FILE *fp, DH *x);
-\& int DHparams_print(BIO *bp, DH *x);
+\& int DHparams_print_fp(FILE *fp, const DH *x);
+\& int DHparams_print(BIO *bp, const DH *x);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
@@ -204,11 +205,19 @@ The \fB\s-1DH\s0\fR structure consists of several \s-1BIGNUM\s0 components.
\& };
\& DH
.Ve
+Note that \s-1DH\s0 keys may use non-standard \fB\s-1DH_METHOD\s0\fR implementations,
+either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
+\&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
+will not be used by the implementation or may be used for alternative data
+storage. For this reason, applications should generally avoid using \s-1DH\s0
+structure elements directly and instead use \s-1API\s0 functions to query or
+modify keys.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
dhparam(1), bn(3), dsa(3), err(3),
-rand(3), rsa(3), DH_set_method(3),
-DH_new(3), DH_get_ex_new_index(3),
+rand(3), rsa(3), engine(3),
+DH_set_method(3), DH_new(3),
+DH_get_ex_new_index(3),
DH_generate_parameters(3),
DH_compute_key(3), d2i_DHparams(3),
RSA_print(3)
OpenPOWER on IntegriCloud