SSL_CTX_set_tmp_dh_callback.3 revision 284285
Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30)

Standard preamble:
========================================================================
..
..
.. 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. \*(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- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is turned on, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "SSL_CTX_set_tmp_dh_callback 3"
SSL_CTX_set_tmp_dh_callback 3 "2015-06-11" "1.0.1n" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
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
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/ssl.h> \& 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); \& void SSL_set_tmp_dh_callback(SSL *ctx, DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength)); long SSL_set_tmp_dh(SSL *ssl, DH *dh) .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fISSL_CTX_set_tmp_dh_callback() sets the callback function for ctx to be used when a \s-1DH\s0 parameters are required to tmp_dh_callback. The callback is inherited by all ssl objects created from ctx.

\fISSL_CTX_set_tmp_dh() sets \s-1DH\s0 parameters to be used to be dh. The key is inherited by all ssl objects created from ctx.

\fISSL_set_tmp_dh_callback() sets the callback only for ssl.

\fISSL_set_tmp_dh() sets the parameters only for ssl.

These functions apply to \s-1SSL/TLS\s0 servers only.

"NOTES"
Header "NOTES" When using a cipher with \s-1RSA\s0 authentication, an ephemeral \s-1DH\s0 key exchange can take place. Ciphers with \s-1DSA\s0 keys always use ephemeral \s-1DH\s0 keys as well. In these cases, the session data are negotiated using the ephemeral/temporary \s-1DH\s0 key and the key supplied and certified by the certificate chain is only used for signing. Anonymous ciphers (without a permanent server key) also use ephemeral \s-1DH\s0 keys.

Using ephemeral \s-1DH\s0 key exchange yields forward secrecy, as the connection can only be decrypted, when the \s-1DH\s0 key is known. By generating a temporary \s-1DH\s0 key inside the server application that is lost when the application is left, it becomes impossible for an attacker to decrypt past sessions, even if he gets hold of the normal (certified) key, as this key was only used for signing.

In order to perform a \s-1DH\s0 key exchange the server must use a \s-1DH\s0 group (\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 if either the \s-1DH\s0 parameters are supplied via callback or the \s-1SSL_OP_SINGLE_DH_USE\s0 option of SSL_CTX_set_options\|(3) is set (or both). It will immediately create a \s-1DH\s0 key if \s-1DH\s0 parameters are supplied via \fISSL_CTX_set_tmp_dh() 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 being needed, while on the other hand the computer time during the negotiation is being saved.

If \*(L"strong\*(R" primes were used to generate the \s-1DH\s0 parameters, it is not strictly necessary to generate a new key for each handshake but it does improve forward secrecy. If it is not assured that \*(L"strong\*(R" primes were used, \s-1SSL_OP_SINGLE_DH_USE\s0 must be used in order to prevent small subgroup attacks. Always using \s-1SSL_OP_SINGLE_DH_USE\s0 has an impact on the computer time needed during negotiation, but it is not very large, so application authors/users should consider always enabling this option. The option is required to implement perfect forward secrecy (\s-1PFS\s0).

As generating \s-1DH\s0 parameters is extremely time consuming, an application should not generate the parameters on the fly but supply the parameters. \s-1DH\s0 parameters can be reused, as the actual key is newly generated during 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. This application guarantees that \*(L"strong\*(R" primes are used.

Files dh2048.pem, and dh4096.pem in the 'apps' directory of the 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. These files can be converted into C code using the -C option of the \fIdhparam\|(1) application. Generation of custom \s-1DH\s0 parameters during installation should still be preferred to stop an attacker from specializing on a commonly used group. Files dh1024.pem and dh512.pem contain old parameters that must not be used by applications.

An application may either directly specify the \s-1DH\s0 parameters or can supply the \s-1DH\s0 parameters via a callback function.

Previous versions of the callback used is_export and keylength parameters to control parameter generation for export and non-export cipher suites. Modern servers that do not support export ciphersuites are advised to either use SSL_CTX_set_tmp_dh() in combination with \s-1SSL_OP_SINGLE_DH_USE,\s0 or alternatively, use the callback but ignore \fBkeylength and is_export and simply supply at least 2048-bit parameters in the callback.

"EXAMPLES"
Header "EXAMPLES" Setup \s-1DH\s0 parameters with a key length of 2048 bits. (Error handling partly left out.)

.Vb 2 Command-line parameter generation: $ openssl dhparam -out dh_param_2048.pem 2048 \& Code for setting up parameters during server initialization: \& ... SSL_CTX ctx = SSL_CTX_new(); ... \& /* Set up ephemeral DH parameters. */ DH *dh_2048 = NULL; FILE *paramfile; paramfile = fopen("dh_param_2048.pem", "r"); if (paramfile) { dh_2048 = PEM_read_DHparams(paramfile, NULL, NULL, NULL); fclose(paramfile); } else { /* Error. */ } if (dh_2048 == NULL) { /* Error. */ } if (SSL_CTX_set_tmp_dh(ctx, dh_2048) != 1) { /* Error. */ } SSL_CTX_set_options(ctx, SSL_OP_SINGLE_DH_USE); ... .Ve

"RETURN VALUES"
Header "RETURN VALUES" \fISSL_CTX_set_tmp_dh_callback() and SSL_set_tmp_dh_callback() do not return diagnostic output.

\fISSL_CTX_set_tmp_dh() and SSL_set_tmp_dh() do return 1 on success and 0 on failure. Check the error queue to find out the reason of failure.

"SEE ALSO"
Header "SEE ALSO" \fIssl\|(3), SSL_CTX_set_cipher_list\|(3), \fISSL_CTX_set_tmp_rsa_callback\|(3), \fISSL_CTX_set_options\|(3), \fIciphers\|(1), dhparam\|(1)