secure/lib/libcrypto/man/SSL_CTX_set_tmp_dh_callback.3

   1 .\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "SSL_CTX_SET_TMP_DH_CALLBACK 3"
 132 .TH SSL_CTX_SET_TMP_DH_CALLBACK 3 "2018-11-20" "1.1.1a" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
 145 \&                                  DH *(*tmp_dh_callback)(SSL *ssl, int is_export,
 146 \&                                                         int keylength));
 147 \& long SSL_CTX_set_tmp_dh(SSL_CTX *ctx, DH *dh);
 148 \&
 149 \& void SSL_set_tmp_dh_callback(SSL *ctx,
 150 \&                              DH *(*tmp_dh_callback)(SSL *ssl, int is_export,
 151 \&                                                     int keylength));
 152 \& long SSL_set_tmp_dh(SSL *ssl, DH *dh)
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fISSL_CTX_set_tmp_dh_callback()\fR sets the callback function for \fBctx\fR to be
 157 used when a \s-1DH\s0 parameters are required to \fBtmp_dh_callback\fR.
 158 The callback is inherited by all \fBssl\fR objects created from \fBctx\fR.
 159 .PP
 160 \&\fISSL_CTX_set_tmp_dh()\fR sets \s-1DH\s0 parameters to be used to be \fBdh\fR.
 161 The key is inherited by all \fBssl\fR objects created from \fBctx\fR.
 162 .PP
 163 \&\fISSL_set_tmp_dh_callback()\fR sets the callback only for \fBssl\fR.
 164 .PP
 165 \&\fISSL_set_tmp_dh()\fR sets the parameters only for \fBssl\fR.
 166 .PP
 167 These functions apply to \s-1SSL/TLS\s0 servers only.
 168 .SH "NOTES"
 169 .IX Header "NOTES"
 170 When using a cipher with \s-1RSA\s0 authentication, an ephemeral \s-1DH\s0 key exchange
 171 can take place. Ciphers with \s-1DSA\s0 keys always use ephemeral \s-1DH\s0 keys as well.
 172 In these cases, the session data are negotiated using the
 173 ephemeral/temporary \s-1DH\s0 key and the key supplied and certified
 174 by the certificate chain is only used for signing.
 175 Anonymous ciphers (without a permanent server key) also use ephemeral \s-1DH\s0 keys.
 176 .PP
 177 Using ephemeral \s-1DH\s0 key exchange yields forward secrecy, as the connection
 178 can only be decrypted, when the \s-1DH\s0 key is known. By generating a temporary
 179 \&\s-1DH\s0 key inside the server application that is lost when the application
 180 is left, it becomes impossible for an attacker to decrypt past sessions,
 181 even if he gets hold of the normal (certified) key, as this key was
 182 only used for signing.
 183 .PP
 184 In order to perform a \s-1DH\s0 key exchange the server must use a \s-1DH\s0 group
 185 (\s-1DH\s0 parameters) and generate a \s-1DH\s0 key. The server will always generate
 186 a new \s-1DH\s0 key during the negotiation.
 187 .PP
 188 As generating \s-1DH\s0 parameters is extremely time consuming, an application
 189 should not generate the parameters on the fly but supply the parameters.
 190 \&\s-1DH\s0 parameters can be reused, as the actual key is newly generated during
 191 the negotiation. The risk in reusing \s-1DH\s0 parameters is that an attacker
 192 may specialize on a very often used \s-1DH\s0 group. Applications should therefore
 193 generate their own \s-1DH\s0 parameters during the installation process using the
 194 openssl \fIdhparam\fR\|(1) application. This application
 195 guarantees that \*(L"strong\*(R" primes are used.
 196 .PP
 197 Files dh2048.pem, and dh4096.pem in the 'apps' directory of the current
 198 version of the OpenSSL distribution contain the '\s-1SKIP\s0' \s-1DH\s0 parameters,
 199 which use safe primes and were generated verifiably pseudo-randomly.
 200 These files can be converted into C code using the \fB\-C\fR option of the
 201 \&\fIdhparam\fR\|(1) application. Generation of custom \s-1DH\s0
 202 parameters during installation should still be preferred to stop an
 203 attacker from specializing on a commonly used group. File dh1024.pem
 204 contains old parameters that must not be used by applications.
 205 .PP
 206 An application may either directly specify the \s-1DH\s0 parameters or
 207 can supply the \s-1DH\s0 parameters via a callback function.
 208 .PP
 209 Previous versions of the callback used \fBis_export\fR and \fBkeylength\fR
 210 parameters to control parameter generation for export and non-export
 211 cipher suites. Modern servers that do not support export cipher suites
 212 are advised to either use \fISSL_CTX_set_tmp_dh()\fR or alternatively, use
 213 the callback but ignore \fBkeylength\fR and \fBis_export\fR and simply
 214 supply at least 2048\-bit parameters in the callback.
 215 .SH "EXAMPLES"
 216 .IX Header "EXAMPLES"
 217 Setup \s-1DH\s0 parameters with a key length of 2048 bits. (Error handling
 218 partly left out.)
 219 .PP
 220 Command-line parameter generation:
 221 .PP
 222 .Vb 1
 223 \& $ openssl dhparam \-out dh_param_2048.pem 2048
 224 .Ve
 225 .PP
 226 Code for setting up parameters during server initialization:
 227 .PP
 228 .Vb 1
 229 \& SSL_CTX ctx = SSL_CTX_new();
 230 \&
 231 \& DH *dh_2048 = NULL;
 232 \& FILE *paramfile = fopen("dh_param_2048.pem", "r");
 233 \&
 234 \& if (paramfile) {
 235 \&     dh_2048 = PEM_read_DHparams(paramfile, NULL, NULL, NULL);
 236 \&     fclose(paramfile);
 237 \& } else {
 238 \&     /* Error. */
 239 \& }
 240 \& if (dh_2048 == NULL)
 241 \&     /* Error. */
 242 \& if (SSL_CTX_set_tmp_dh(ctx, dh_2048) != 1)
 243 \&     /* Error. */
 244 \& ...
 245 .Ve
 246 .SH "RETURN VALUES"
 247 .IX Header "RETURN VALUES"
 248 \&\fISSL_CTX_set_tmp_dh_callback()\fR and \fISSL_set_tmp_dh_callback()\fR do not return
 249 diagnostic output.
 250 .PP
 251 \&\fISSL_CTX_set_tmp_dh()\fR and \fISSL_set_tmp_dh()\fR do return 1 on success and 0
 252 on failure. Check the error queue to find out the reason of failure.
 253 .SH "SEE ALSO"
 254 .IX Header "SEE ALSO"
 255 \&\fIssl\fR\|(7), \fISSL_CTX_set_cipher_list\fR\|(3),
 256 \&\fISSL_CTX_set_options\fR\|(3),
 257 \&\fIciphers\fR\|(1), \fIdhparam\fR\|(1)
 258 .SH "COPYRIGHT"
 259 .IX Header "COPYRIGHT"
 260 Copyright 2001\-2016 The OpenSSL Project Authors. All Rights Reserved.
 261 .PP
 262 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 263 this file except in compliance with the License.  You can obtain a copy
 264 in the file \s-1LICENSE\s0 in the source distribution or at
 265 <https://www.openssl.org/source/license.html>.