- update OpenSSL to 0.9.8
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_tmp_dh_callback.3
index 6b798b6..836ae7b 100644 (file)
@@ -1,8 +1,7 @@
-.\" Automatically generated by Pod::Man version 1.15
-.\" Wed Feb 19 16:47:42 2003
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
 .\"
 .\" Standard preamble:
-.\" ======================================================================
+.\" ========================================================================
 .de Sh \" Subsection heading
 .br
 .if t .Sp
 .if t .sp .5v
 .if n .sp
 ..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
 .de Vb \" Begin verbatim text
 .ft CW
 .nf
 ..
 .de Ve \" End verbatim text
 .ft R
-
 .fi
 ..
 .\" Set up some character translations and predefined strings.  \*(-- will
 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
 .\" double quote, and \*(R" will give a right double quote.  | will give a
-.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
-.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
-.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
+.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
+.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
+.\" expand to `' in nroff, nothing in troff, for use with C<>.
 .tr \(*W-|\(bv\*(Tr
 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
 .ie n \{\
 .    ds R" ''
 'br\}
 .\"
-.\" If the F register is turned on, we'll generate index entries on stderr
-.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
-.\" index entries marked with X<> in POD.  Of course, you'll have to process
-.\" the output yourself in some meaningful fashion.
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD.  Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
 .if \nF \{\
 .    de IX
 .    tm Index:\\$1\t\\n%\t"\\$2"
 .    rr F
 .\}
 .\"
-.\" For nroff, turn off justification.  Always turn off hyphenation; it
-.\" makes way too many mistakes in technical documents.
+.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
 .hy 0
 .if n .na
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
-.bd B 3
 .    \" fudge factors for nroff and troff
 .if n \{\
 .    ds #H 0
 .    ds Ae AE
 .\}
 .rm #[ #] #H #V #F C
-.\" ======================================================================
+.\" ========================================================================
 .\"
 .IX Title "SSL_CTX_set_tmp_dh_callback 3"
-.TH SSL_CTX_set_tmp_dh_callback 3 "0.9.7a" "2003-02-19" "OpenSSL"
-.UC
+.TH SSL_CTX_set_tmp_dh_callback 3 "2005-07-06" "0.9.8" "OpenSSL"
 .SH "NAME"
-SSL_CTX_set_tmp_dh_callback, SSL_CTX_set_tmp_dh, SSL_set_tmp_dh_callback, SSL_set_tmp_dh \- handle \s-1DH\s0 keys for ephemeral key exchange
+SSL_CTX_set_tmp_dh_callback, SSL_CTX_set_tmp_dh, SSL_set_tmp_dh_callback, SSL_set_tmp_dh \- handle DH keys for ephemeral key exchange
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
 .Vb 1
 \& #include <openssl/ssl.h>
 .Ve
+.PP
 .Vb 3
 \& void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
 \&            DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
 \& long SSL_CTX_set_tmp_dh(SSL_CTX *ctx, DH *dh);
 .Ve
+.PP
 .Vb 3
 \& void SSL_set_tmp_dh_callback(SSL_CTX *ctx,
 \&            DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
 \& long SSL_set_tmp_dh(SSL *ssl, DH *dh)
 .Ve
+.PP
 .Vb 1
 \& DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
 .Ve
@@ -194,7 +187,7 @@ In order to perform a \s-1DH\s0 key exchange the server must use a \s-1DH\s0 gro
 (\s-1DH\s0 parameters) and generate a \s-1DH\s0 key. The server will always generate a new
 \&\s-1DH\s0 key during the negotiation, when the \s-1DH\s0 parameters are supplied via
 callback and/or when the \s-1SSL_OP_SINGLE_DH_USE\s0 option of
-SSL_CTX_set_options(3) is set. It will
+\&\fISSL_CTX_set_options\fR\|(3) is set. It will
 immediately create a \s-1DH\s0 key, when \s-1DH\s0 parameters are supplied via
 \&\fISSL_CTX_set_tmp_dh()\fR and \s-1SSL_OP_SINGLE_DH_USE\s0 is not set. In this case,
 it may happen that a key is generated on initialization without later
@@ -216,19 +209,19 @@ should not generate the parameters on the fly but supply the parameters.
 the negotiation. The risk in reusing \s-1DH\s0 parameters is that an attacker
 may specialize on a very often used \s-1DH\s0 group. Applications should therefore
 generate their own \s-1DH\s0 parameters during the installation process using the
-openssl dhparam(1) application. In order to reduce the computer
+openssl \fIdhparam\fR\|(1) application. In order to reduce the computer
 time needed for this generation, it is possible to use \s-1DSA\s0 parameters
-instead (see dhparam(1)), but in this case \s-1SSL_OP_SINGLE_DH_USE\s0
+instead (see \fIdhparam\fR\|(1)), but in this case \s-1SSL_OP_SINGLE_DH_USE\s0
 is mandatory.
 .PP
 Application authors may compile in \s-1DH\s0 parameters. Files dh512.pem,
 dh1024.pem, dh2048.pem, and dh4096 in the 'apps' directory of current
 version of the OpenSSL distribution contain the '\s-1SKIP\s0' \s-1DH\s0 parameters,
-which use safe primes and were generated verifiably pseudo-randomly.
+which use safe primes and were generated verifiably pseudo\-randomly.
 These files can be converted into C code using the \fB\-C\fR option of the
-dhparam(1) application.
+\&\fIdhparam\fR\|(1) application.
 Authors may also generate their own set of parameters using
-dhparam(1), but a user may not be sure how the parameters were
+\&\fIdhparam\fR\|(1), but a user may not be sure how the parameters were
 generated. The generation of \s-1DH\s0 parameters during installation is therefore
 recommended.
 .PP
@@ -252,6 +245,7 @@ partly left out.)
 \& DH *dh_1024 = NULL;
 \& FILE *paramfile;
 .Ve
+.PP
 .Vb 14
 \& ...
 \& /* "openssl dhparam -out dh_param_512.pem -2 512" */
@@ -268,16 +262,19 @@ partly left out.)
 \& }
 \& ...
 .Ve
+.PP
 .Vb 3
 \& /* "openssl dhparam -C -2 512" etc... */
 \& DH *get_dh512() { ... }
 \& DH *get_dh1024() { ... }
 .Ve
+.PP
 .Vb 3
 \& DH *tmp_dh_callback(SSL *s, int is_export, int keylength)
 \& {
 \&    DH *dh_tmp=NULL;
 .Ve
+.PP
 .Vb 17
 \&    switch (keylength) {
 \&    case 512:
@@ -306,7 +303,7 @@ diagnostic output.
 on failure. Check the error queue to find out the reason of failure.
 .SH "SEE ALSO"
 .IX Header "SEE ALSO"
-ssl(3), SSL_CTX_set_cipher_list(3),
-SSL_CTX_set_tmp_rsa_callback(3),
-SSL_CTX_set_options(3),
-ciphers(1), dhparam(1)
+\&\fIssl\fR\|(3), \fISSL_CTX_set_cipher_list\fR\|(3),
+\&\fISSL_CTX_set_tmp_rsa_callback\fR\|(3),
+\&\fISSL_CTX_set_options\fR\|(3),
+\&\fIciphers\fR\|(1), \fIdhparam\fR\|(1)