
#use wml::openssl-macros area=docs page=SSL_CTX_set_tmp_dh_callback

<title>Documents, SSL_CTX_set_tmp_dh_callback(3)</title>

<h1>SSL_CTX_set_tmp_dh_callback(3)</h1>

#use wml::imp::generic

{:
## What's this? [[s|(<STRONG>[^<].+?)</A>(</STRONG><DD>)|$1$2|sg]]
[[s|<P>\s+<P>|<P>|sg]]
[[s|<P>\s+</|</|sg]]
[[s|<DD>\s*<DT>|<DD>&nbsp;<DT>|sg]]
[[s|<DD>\s*</DL>|<DD>&nbsp;</DL>|sg]]
[[s|\[|&#91;|sg]]
[[s|\]|&#93;|sg]]

<!-- INDEX BEGIN -->

<UL>

	<LI><A HREF="#NAME">NAME</A>
	<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
	<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
	<LI><A HREF="#NOTES">NOTES</A>
	<LI><A HREF="#EXAMPLES">EXAMPLES</A>
	<LI><A HREF="#RETURN_VALUES">RETURN VALUES</A>
	<LI><A HREF="#SEE_ALSO">SEE ALSO</A>
</UL>
<!-- INDEX END -->

<HR>
<P>
<HR>
<H1><A NAME="NAME">NAME</A></H1>
<P>
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

</P>
<P>
<HR>
<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
<PRE> #include &lt;openssl/ssl.h&gt;
</PRE>
<PRE> 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);
</PRE>
<PRE> 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)
</PRE>
<PRE> DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
</PRE>
<P>
<HR>
<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
<P>
<CODE>SSL_CTX_set_tmp_dh_callback()</CODE> sets the callback function for <STRONG>ctx</STRONG> to be used when a DH parameters are required to <STRONG>tmp_dh_callback</STRONG>. The callback is inherited by all <STRONG>ssl</STRONG> objects created from <STRONG>ctx</STRONG>.

</P>
<P>
<CODE>SSL_CTX_set_tmp_dh()</CODE> sets DH parameters to be used to be <STRONG>dh</STRONG>. The key is inherited by all <STRONG>ssl</STRONG> objects created from <STRONG>ctx</STRONG>.

</P>
<P>
<CODE>SSL_set_tmp_dh_callback()</CODE> sets the callback only for <STRONG>ssl</STRONG>.

</P>
<P>
<CODE>SSL_set_tmp_dh()</CODE> sets the parameters only for <STRONG>ssl</STRONG>.

</P>
<P>
These functions apply to SSL/TLS servers only.

</P>
<P>
<HR>
<H1><A NAME="NOTES">NOTES</A></H1>
<P>
When using a cipher with RSA authentication, an ephemeral DH key exchange
can take place. Ciphers with DSA keys always use ephemeral DH keys as well.
In these cases, the session data are negotiated using the
ephemeral/temporary DH 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 DH keys.

</P>
<P>
Using ephemeral DH key exchange yields forward secrecy, as the connection
can only be decrypted, when the DH key is known. By generating a temporary
DH 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.

</P>
<P>
In order to perform a DH key exchange the server must use a DH group (DH
parameters) and generate a DH key. The server will always generate a new DH
key during the negotiation, when the DH parameters are supplied via
callback and/or when the SSL_OP_SINGLE_DH_USE option of
<A HREF="../ssl/SSL_CTX_set_options.html#">SSL_CTX_set_options(3)</A> is set. It will immediately create a DH key, when DH parameters are
supplied via <CODE>SSL_CTX_set_tmp_dh()</CODE> and SSL_OP_SINGLE_DH_USE 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.

</P>
<P>
If ``strong'' primes were used to generate the DH 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 ``strong'' primes were
used (see especially the section about DSA parameters below),
SSL_OP_SINGLE_DH_USE must be used in order to prevent small subgroup
attacks. Always using SSL_OP_SINGLE_DH_USE has an impact on the computer
time needed during negotiation, but it is not very large, so application
authors/users should consider to always enable this option.

</P>
<P>
As generating DH parameters is extremely time consuming, an application
should not generate the parameters on the fly but supply the parameters. DH
parameters can be reused, as the actual key is newly generated during the
negotiation. The risk in reusing DH parameters is that an attacker may
specialize on a very often used DH group. Applications should therefore
generate their own DH parameters during the installation process using the
openssl <A HREF="../apps/dhparam.html#">dhparam(1)</A> application. In order to reduce the computer time needed for this
generation, it is possible to use DSA parameters instead (see <A HREF="../apps/dhparam.html#">dhparam(1)</A>), but in this case SSL_OP_SINGLE_DH_USE is mandatory.

</P>
<P>
Application authors may compile in DH parameters. Files dh512.pem,
dh1024.pem, dh2048.pem, and dh4096 in the 'apps' directory of current
version of the OpenSSL distribution contain the 'SKIP' DH parameters, which
use safe primes and were generated verifiably pseudo-randomly. These files
can be converted into C code using the <STRONG>-C</STRONG> option of the
<A HREF="../apps/dhparam.html#">dhparam(1)</A> application. Authors may also generate their own set of parameters using
<A HREF="../apps/dhparam.html#">dhparam(1)</A>, but a user may not be sure how the parameters were generated. The
generation of DH parameters during installation is therefore recommended.

</P>
<P>
An application may either directly specify the DH parameters or can supply
the DH parameters via a callback function. The callback approach has the
advantage, that the callback may supply DH parameters for different key
lengths.

</P>
<P>
The <STRONG>tmp_dh_callback</STRONG> is called with the <STRONG>keylength</STRONG> needed and the <STRONG>is_export</STRONG> information. The <STRONG>is_export</STRONG> flag is set, when the ephemeral DH key exchange is performed with an export
cipher.

</P>
<P>
<HR>
<H1><A NAME="EXAMPLES">EXAMPLES</A></H1>
<P>
Handle DH parameters for key lengths of 512 and 1024 bits. (Error handling
partly left out.)

</P>
<PRE> ...
 /* Set up ephemeral DH stuff */
 DH *dh_512 = NULL;
 DH *dh_1024 = NULL;
 FILE *paramfile;
</PRE>
<PRE> ...
 /* &quot;openssl dhparam -out dh_param_512.pem -2 512&quot; */
 paramfile = fopen(&quot;dh_param_512.pem&quot;, &quot;r&quot;);
 if (paramfile) {
   dh_512 = PEM_read_DHparams(paramfile, NULL, NULL, NULL);
   fclose(paramfile);
 }
 /* &quot;openssl dhparam -out dh_param_1024.pem -2 1024&quot; */
 paramfile = fopen(&quot;dh_param_1024.pem&quot;, &quot;r&quot;);
 if (paramfile) {
   dh_1024 = PEM_read_DHparams(paramfile, NULL, NULL, NULL);
   fclose(paramfile);
 }
 ...
</PRE>
<PRE> /* &quot;openssl dhparam -C -2 512&quot; etc... */
 DH *get_dh512() { ... }
 DH *get_dh1024() { ... }
</PRE>
<PRE> DH *tmp_dh_callback(SSL *s, int is_export, int keylength)
 {
    DH *dh_tmp=NULL;
</PRE>
<PRE>    switch (keylength) {
    case 512:
      if (!dh_512)
        dh_512 = get_dh512();
      dh_tmp = dh_512;
      break;
    case 1024:
      if (!dh_1024) 
        dh_1024 = get_dh1024();
      dh_tmp = dh_1024;
      break;
    default:
      /* Generating a key on the fly is very costly, so use what is there */
      setup_dh_parameters_like_above();
    }
    return(dh_tmp);
 }
</PRE>
<P>
<HR>
<H1><A NAME="RETURN_VALUES">RETURN VALUES</A></H1>
<P>
<CODE>SSL_CTX_set_tmp_dh_callback()</CODE> and
<CODE>SSL_set_tmp_dh_callback()</CODE> do not return diagnostic output.

</P>
<P>
<CODE>SSL_CTX_set_tmp_dh()</CODE> and <CODE>SSL_set_tmp_dh()</CODE> do
return 1 on success and 0 on failure. Check the error queue to find out the
reason of failure.

</P>
<P>
<HR>
<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
<P>
<A HREF="../ssl/ssl.html#">ssl(3)</A>, <A HREF="../ssl/SSL_CTX_set_cipher_list.html#">SSL_CTX_set_cipher_list(3)</A>,
<A HREF="../ssl/SSL_CTX_set_tmp_rsa_callback.html#">SSL_CTX_set_tmp_rsa_callback(3)</A>,
<A HREF="../ssl/SSL_CTX_set_options.html#">SSL_CTX_set_options(3)</A>,
<A HREF="../apps/ciphers.html#">ciphers(1)</A>, <A HREF="../apps/dhparam.html#">dhparam(1)</A>



</P>
:}

