secure/lib/libssl/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-08-14" "1.0.2p" "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, int keylength));
 146 \& long SSL_CTX_set_tmp_dh(SSL_CTX *ctx, DH *dh);
 147 \&
 148 \& void SSL_set_tmp_dh_callback(SSL *ctx,
 149 \&            DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
 150 \& long SSL_set_tmp_dh(SSL *ssl, DH *dh)
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fISSL_CTX_set_tmp_dh_callback()\fR sets the callback function for \fBctx\fR to be
 155 used when a \s-1DH\s0 parameters are required to \fBtmp_dh_callback\fR.
 156 The callback is inherited by all \fBssl\fR objects created from \fBctx\fR.
 157 .PP
 158 \&\fISSL_CTX_set_tmp_dh()\fR sets \s-1DH\s0 parameters to be used to be \fBdh\fR.
 159 The key is inherited by all \fBssl\fR objects created from \fBctx\fR.
 160 .PP
 161 \&\fISSL_set_tmp_dh_callback()\fR sets the callback only for \fBssl\fR.
 162 .PP
 163 \&\fISSL_set_tmp_dh()\fR sets the parameters only for \fBssl\fR.
 164 .PP
 165 These functions apply to \s-1SSL/TLS\s0 servers only.
 166 .SH "NOTES"
 167 .IX Header "NOTES"
 168 When using a cipher with \s-1RSA\s0 authentication, an ephemeral \s-1DH\s0 key exchange
 169 can take place. Ciphers with \s-1DSA\s0 keys always use ephemeral \s-1DH\s0 keys as well.
 170 In these cases, the session data are negotiated using the
 171 ephemeral/temporary \s-1DH\s0 key and the key supplied and certified
 172 by the certificate chain is only used for signing.
 173 Anonymous ciphers (without a permanent server key) also use ephemeral \s-1DH\s0 keys.
 174 .PP
 175 Using ephemeral \s-1DH\s0 key exchange yields forward secrecy, as the connection
 176 can only be decrypted, when the \s-1DH\s0 key is known. By generating a temporary
 177 \&\s-1DH\s0 key inside the server application that is lost when the application
 178 is left, it becomes impossible for an attacker to decrypt past sessions,
 179 even if he gets hold of the normal (certified) key, as this key was
 180 only used for signing.
 181 .PP
 182 In order to perform a \s-1DH\s0 key exchange the server must use a \s-1DH\s0 group
 183 (\s-1DH\s0 parameters) and generate a \s-1DH\s0 key. The server will always generate
 184 a new \s-1DH\s0 key during the negotiation.
 185 .PP
 186 As generating \s-1DH\s0 parameters is extremely time consuming, an application
 187 should not generate the parameters on the fly but supply the parameters.
 188 \&\s-1DH\s0 parameters can be reused, as the actual key is newly generated during
 189 the negotiation. The risk in reusing \s-1DH\s0 parameters is that an attacker
 190 may specialize on a very often used \s-1DH\s0 group. Applications should therefore
 191 generate their own \s-1DH\s0 parameters during the installation process using the
 192 openssl \fIdhparam\fR\|(1) application. This application
 193 guarantees that \*(L"strong\*(R" primes are used.
 194 .PP
 195 Files dh2048.pem, and dh4096.pem in the 'apps' directory of the current
 196 version of the OpenSSL distribution contain the '\s-1SKIP\s0' \s-1DH\s0 parameters,
 197 which use safe primes and were generated verifiably pseudo-randomly.
 198 These files can be converted into C code using the \fB\-C\fR option of the
 199 \&\fIdhparam\fR\|(1) application. Generation of custom \s-1DH\s0
 200 parameters during installation should still be preferred to stop an
 201 attacker from specializing on a commonly used group. Files dh1024.pem
 202 and dh512.pem contain old parameters that must not be used by
 203 applications.
 204 .PP
 205 An application may either directly specify the \s-1DH\s0 parameters or
 206 can supply the \s-1DH\s0 parameters via a callback function.
 207 .PP
 208 Previous versions of the callback used \fBis_export\fR and \fBkeylength\fR
 209 parameters to control parameter generation for export and non-export
 210 cipher suites. Modern servers that do not support export ciphersuites
 211 are advised to either use \fISSL_CTX_set_tmp_dh()\fR or alternatively, use
 212 the callback but ignore \fBkeylength\fR and \fBis_export\fR and simply
 213 supply at least 2048\-bit parameters in the callback.
 214 .SH "EXAMPLES"
 215 .IX Header "EXAMPLES"
 216 Setup \s-1DH\s0 parameters with a key length of 2048 bits. (Error handling
 217 partly left out.)
 218 .PP
 219 .Vb 2
 220 \& Command\-line parameter generation:
 221 \& $ openssl dhparam \-out dh_param_2048.pem 2048
 222 \&
 223 \& Code for setting up parameters during server initialization:
 224 \&
 225 \& ...
 226 \& SSL_CTX ctx = SSL_CTX_new();
 227 \& ...
 228 \&
 229 \& /* Set up ephemeral DH parameters. */
 230 \& DH *dh_2048 = NULL;
 231 \& FILE *paramfile;
 232 \& paramfile = fopen("dh_param_2048.pem", "r");
 233 \& if (paramfile) {
 234 \&   dh_2048 = PEM_read_DHparams(paramfile, NULL, NULL, NULL);
 235 \&   fclose(paramfile);
 236 \& } else {
 237 \&   /* Error. */
 238 \& }
 239 \& if (dh_2048 == NULL) {
 240 \&  /* Error. */
 241 \& }
 242 \& if (SSL_CTX_set_tmp_dh(ctx, dh_2048) != 1) {
 243 \&   /* Error. */
 244 \& }
 245 \& ...
 246 .Ve
 247 .SH "RETURN VALUES"
 248 .IX Header "RETURN VALUES"
 249 \&\fISSL_CTX_set_tmp_dh_callback()\fR and \fISSL_set_tmp_dh_callback()\fR do not return
 250 diagnostic output.
 251 .PP
 252 \&\fISSL_CTX_set_tmp_dh()\fR and \fISSL_set_tmp_dh()\fR do return 1 on success and 0
 253 on failure. Check the error queue to find out the reason of failure.
 254 .SH "SEE ALSO"
 255 .IX Header "SEE ALSO"
 256 \&\fIssl\fR\|(3), \fISSL_CTX_set_cipher_list\fR\|(3),
 257 \&\fISSL_CTX_set_tmp_rsa_callback\fR\|(3),
 258 \&\fISSL_CTX_set_options\fR\|(3),
 259 \&\fIciphers\fR\|(1), \fIdhparam\fR\|(1)