secure/lib/libcrypto/man/man3/SSL_CTX_set_tmp_dh_callback.3

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