crypto/openssl/doc/ssl/SSL_CTX_set_tmp_dh_callback.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 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
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
  12             DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
  13  long SSL_CTX_set_tmp_dh(SSL_CTX *ctx, DH *dh);
  14
  15  void SSL_set_tmp_dh_callback(SSL *ctx,
  16             DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
  17  long SSL_set_tmp_dh(SSL *ssl, DH *dh)
  18
  19 =head1 DESCRIPTION
  20
  21 SSL_CTX_set_tmp_dh_callback() sets the callback function for B<ctx> to be
  22 used when a DH parameters are required to B<tmp_dh_callback>.
  23 The callback is inherited by all B<ssl> objects created from B<ctx>.
  24
  25 SSL_CTX_set_tmp_dh() sets DH parameters to be used to be B<dh>.
  26 The key is inherited by all B<ssl> objects created from B<ctx>.
  27
  28 SSL_set_tmp_dh_callback() sets the callback only for B<ssl>.
  29
  30 SSL_set_tmp_dh() sets the parameters only for B<ssl>.
  31
  32 These functions apply to SSL/TLS servers only.
  33
  34 =head1 NOTES
  35
  36 When using a cipher with RSA authentication, an ephemeral DH key exchange
  37 can take place. Ciphers with DSA keys always use ephemeral DH keys as well.
  38 In these cases, the session data are negotiated using the
  39 ephemeral/temporary DH key and the key supplied and certified
  40 by the certificate chain is only used for signing.
  41 Anonymous ciphers (without a permanent server key) also use ephemeral DH keys.
  42
  43 Using ephemeral DH key exchange yields forward secrecy, as the connection
  44 can only be decrypted, when the DH key is known. By generating a temporary
  45 DH key inside the server application that is lost when the application
  46 is left, it becomes impossible for an attacker to decrypt past sessions,
  47 even if he gets hold of the normal (certified) key, as this key was
  48 only used for signing.
  49
  50 In order to perform a DH key exchange the server must use a DH group
  51 (DH parameters) and generate a DH key. The server will always generate a new
  52 DH key during the negotiation, when the DH parameters are supplied via
  53 callback and/or when the SSL_OP_SINGLE_DH_USE option of
  54 L<SSL_CTX_set_options(3)|SSL_CTX_set_options(3)> is set. It will
  55 immediately create a DH key, when DH parameters are supplied via
  56 SSL_CTX_set_tmp_dh() and SSL_OP_SINGLE_DH_USE is not set. In this case,
  57 it may happen that a key is generated on initialization without later
  58 being needed, while on the other hand the computer time during the
  59 negotiation is being saved.
  60
  61 If "strong" primes were used to generate the DH parameters, it is not strictly
  62 necessary to generate a new key for each handshake but it does improve forward
  63 secrecy. If it is not assured, that "strong" primes were used (see especially
  64 the section about DSA parameters below), SSL_OP_SINGLE_DH_USE must be used
  65 in order to prevent small subgroup attacks. Always using SSL_OP_SINGLE_DH_USE
  66 has an impact on the computer time needed during negotiation, but it is not
  67 very large, so application authors/users should consider to always enable
  68 this option.
  69
  70 As generating DH parameters is extremely time consuming, an application
  71 should not generate the parameters on the fly but supply the parameters.
  72 DH parameters can be reused, as the actual key is newly generated during
  73 the negotiation. The risk in reusing DH parameters is that an attacker
  74 may specialize on a very often used DH group. Applications should therefore
  75 generate their own DH parameters during the installation process using the
  76 openssl L<dhparam(1)|dhparam(1)> application. In order to reduce the computer
  77 time needed for this generation, it is possible to use DSA parameters
  78 instead (see L<dhparam(1)|dhparam(1)>), but in this case SSL_OP_SINGLE_DH_USE
  79 is mandatory.
  80
  81 Application authors may compile in DH parameters. Files dh512.pem,
  82 dh1024.pem, dh2048.pem, and dh4096.pem in the 'apps' directory of current
  83 version of the OpenSSL distribution contain the 'SKIP' DH parameters,
  84 which use safe primes and were generated verifiably pseudo-randomly.
  85 These files can be converted into C code using the B<-C> option of the
  86 L<dhparam(1)|dhparam(1)> application.
  87 Authors may also generate their own set of parameters using
  88 L<dhparam(1)|dhparam(1)>, but a user may not be sure how the parameters were
  89 generated. The generation of DH parameters during installation is therefore
  90 recommended.
  91
  92 An application may either directly specify the DH parameters or
  93 can supply the DH parameters via a callback function. The callback approach
  94 has the advantage, that the callback may supply DH parameters for different
  95 key lengths.
  96
  97 The B<tmp_dh_callback> is called with the B<keylength> needed and
  98 the B<is_export> information. The B<is_export> flag is set, when the
  99 ephemeral DH key exchange is performed with an export cipher.
 100
 101 =head1 EXAMPLES
 102
 103 Handle DH parameters for key lengths of 512 and 1024 bits. (Error handling
 104 partly left out.)
 105
 106  ...
 107  /* Set up ephemeral DH stuff */
 108  DH *dh_512 = NULL;
 109  DH *dh_1024 = NULL;
 110  FILE *paramfile;
 111
 112  ...
 113  /* "openssl dhparam -out dh_param_512.pem -2 512" */
 114  paramfile = fopen("dh_param_512.pem", "r");
 115  if (paramfile) {
 116    dh_512 = PEM_read_DHparams(paramfile, NULL, NULL, NULL);
 117    fclose(paramfile);
 118  }
 119  /* "openssl dhparam -out dh_param_1024.pem -2 1024" */
 120  paramfile = fopen("dh_param_1024.pem", "r");
 121  if (paramfile) {
 122    dh_1024 = PEM_read_DHparams(paramfile, NULL, NULL, NULL);
 123    fclose(paramfile);
 124  }
 125  ...
 126
 127  /* "openssl dhparam -C -2 512" etc... */
 128  DH *get_dh512() { ... }
 129  DH *get_dh1024() { ... }
 130
 131  DH *tmp_dh_callback(SSL *s, int is_export, int keylength)
 132  {
 133     DH *dh_tmp=NULL;
 134
 135     switch (keylength) {
 136     case 512:
 137       if (!dh_512)
 138         dh_512 = get_dh512();
 139       dh_tmp = dh_512;
 140       break;
 141     case 1024:
 142       if (!dh_1024)
 143         dh_1024 = get_dh1024();
 144       dh_tmp = dh_1024;
 145       break;
 146     default:
 147       /* Generating a key on the fly is very costly, so use what is there */
 148       setup_dh_parameters_like_above();
 149     }
 150     return(dh_tmp);
 151  }
 152
 153 =head1 RETURN VALUES
 154
 155 SSL_CTX_set_tmp_dh_callback() and SSL_set_tmp_dh_callback() do not return
 156 diagnostic output.
 157
 158 SSL_CTX_set_tmp_dh() and SSL_set_tmp_dh() do return 1 on success and 0
 159 on failure. Check the error queue to find out the reason of failure.
 160
 161 =head1 SEE ALSO
 162
 163 L<ssl(3)|ssl(3)>, L<SSL_CTX_set_cipher_list(3)|SSL_CTX_set_cipher_list(3)>,
 164 L<SSL_CTX_set_tmp_rsa_callback(3)|SSL_CTX_set_tmp_rsa_callback(3)>,
 165 L<SSL_CTX_set_options(3)|SSL_CTX_set_options(3)>,
 166 L<ciphers(1)|ciphers(1)>, L<dhparam(1)|dhparam(1)>
 167
 168 =cut