secure/lib/libssl/man/SSL_CTX_set_tmp_dh_callback.3

   1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  31 .\" nothing in troff, for use with C<>.
  32 .tr \(*W-
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" Escape single quotes in literal strings from groff's Unicode transform.
  52 .ie \n(.g .ds Aq \(aq
  53 .el       .ds Aq '
  54 .\"
  55 .\" If the F register is turned on, we'll generate index entries on stderr for
  56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  58 .\" output yourself in some meaningful fashion.
  59 .ie \nF \{\
  60 .    de IX
  61 .    tm Index:\\$1\t\\n%\t"\\$2"
  62 ..
  63 .    nr % 0
  64 .    rr F
  65 .\}
  66 .el \{\
  67 .    de IX
  68 ..
  69 .\}
  70 .\"
  71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  73 .    \" fudge factors for nroff and troff
  74 .if n \{\
  75 .    ds #H 0
  76 .    ds #V .8m
  77 .    ds #F .3m
  78 .    ds #[ \f1
  79 .    ds #] \fP
  80 .\}
  81 .if t \{\
  82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  83 .    ds #V .6m
  84 .    ds #F 0
  85 .    ds #[ \&
  86 .    ds #] \&
  87 .\}
  88 .    \" simple accents for nroff and troff
  89 .if n \{\
  90 .    ds ' \&
  91 .    ds ` \&
  92 .    ds ^ \&
  93 .    ds , \&
  94 .    ds ~ ~
  95 .    ds /
  96 .\}
  97 .if t \{\
  98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 104 .\}
 105 .    \" troff and (daisy-wheel) nroff accents
 106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 113 .ds ae a\h'-(\w'a'u*4/10)'e
 114 .ds Ae A\h'-(\w'A'u*4/10)'E
 115 .    \" corrections for vroff
 116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 118 .    \" for low resolution devices (crt and lpr)
 119 .if \n(.H>23 .if \n(.V>19 \
 120 \{\
 121 .    ds : e
 122 .    ds 8 ss
 123 .    ds o a
 124 .    ds d- d\h'-1'\(ga
 125 .    ds D- D\h'-1'\(hy
 126 .    ds th \o'bp'
 127 .    ds Th \o'LP'
 128 .    ds ae ae
 129 .    ds Ae AE
 130 .\}
 131 .rm #[ #] #H #V #F C
 132 .\" ========================================================================
 133 .\"
 134 .IX Title "SSL_CTX_set_tmp_dh_callback 3"
 135 .TH SSL_CTX_set_tmp_dh_callback 3 "2009-04-11" "0.9.8k" "OpenSSL"
 136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 137 .\" way too many mistakes in technical documents.
 138 .if n .ad l
 139 .nh
 140 .SH "NAME"
 141 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
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 .Vb 1
 145 \& #include <openssl/ssl.h>
 146 \&
 147 \& void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
 148 \&            DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
 149 \& long SSL_CTX_set_tmp_dh(SSL_CTX *ctx, DH *dh);
 150 \&
 151 \& void SSL_set_tmp_dh_callback(SSL_CTX *ctx,
 152 \&            DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
 153 \& long SSL_set_tmp_dh(SSL *ssl, DH *dh)
 154 \&
 155 \& DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
 156 .Ve
 157 .SH "DESCRIPTION"
 158 .IX Header "DESCRIPTION"
 159 \&\fISSL_CTX_set_tmp_dh_callback()\fR sets the callback function for \fBctx\fR to be
 160 used when a \s-1DH\s0 parameters are required to \fBtmp_dh_callback\fR.
 161 The callback is inherited by all \fBssl\fR objects created from \fBctx\fR.
 162 .PP
 163 \&\fISSL_CTX_set_tmp_dh()\fR sets \s-1DH\s0 parameters to be used to be \fBdh\fR.
 164 The key is inherited by all \fBssl\fR objects created from \fBctx\fR.
 165 .PP
 166 \&\fISSL_set_tmp_dh_callback()\fR sets the callback only for \fBssl\fR.
 167 .PP
 168 \&\fISSL_set_tmp_dh()\fR sets the parameters only for \fBssl\fR.
 169 .PP
 170 These functions apply to \s-1SSL/TLS\s0 servers only.
 171 .SH "NOTES"
 172 .IX Header "NOTES"
 173 When using a cipher with \s-1RSA\s0 authentication, an ephemeral \s-1DH\s0 key exchange
 174 can take place. Ciphers with \s-1DSA\s0 keys always use ephemeral \s-1DH\s0 keys as well.
 175 In these cases, the session data are negotiated using the
 176 ephemeral/temporary \s-1DH\s0 key and the key supplied and certified
 177 by the certificate chain is only used for signing.
 178 Anonymous ciphers (without a permanent server key) also use ephemeral \s-1DH\s0 keys.
 179 .PP
 180 Using ephemeral \s-1DH\s0 key exchange yields forward secrecy, as the connection
 181 can only be decrypted, when the \s-1DH\s0 key is known. By generating a temporary
 182 \&\s-1DH\s0 key inside the server application that is lost when the application
 183 is left, it becomes impossible for an attacker to decrypt past sessions,
 184 even if he gets hold of the normal (certified) key, as this key was
 185 only used for signing.
 186 .PP
 187 In order to perform a \s-1DH\s0 key exchange the server must use a \s-1DH\s0 group
 188 (\s-1DH\s0 parameters) and generate a \s-1DH\s0 key. The server will always generate a new
 189 \&\s-1DH\s0 key during the negotiation, when the \s-1DH\s0 parameters are supplied via
 190 callback and/or when the \s-1SSL_OP_SINGLE_DH_USE\s0 option of
 191 \&\fISSL_CTX_set_options\fR\|(3) is set. It will
 192 immediately create a \s-1DH\s0 key, when \s-1DH\s0 parameters are supplied via
 193 \&\fISSL_CTX_set_tmp_dh()\fR and \s-1SSL_OP_SINGLE_DH_USE\s0 is not set. In this case,
 194 it may happen that a key is generated on initialization without later
 195 being needed, while on the other hand the computer time during the
 196 negotiation is being saved.
 197 .PP
 198 If \*(L"strong\*(R" primes were used to generate the \s-1DH\s0 parameters, it is not strictly
 199 necessary to generate a new key for each handshake but it does improve forward
 200 secrecy. If it is not assured, that \*(L"strong\*(R" primes were used (see especially
 201 the section about \s-1DSA\s0 parameters below), \s-1SSL_OP_SINGLE_DH_USE\s0 must be used
 202 in order to prevent small subgroup attacks. Always using \s-1SSL_OP_SINGLE_DH_USE\s0
 203 has an impact on the computer time needed during negotiation, but it is not
 204 very large, so application authors/users should consider to always enable
 205 this option.
 206 .PP
 207 As generating \s-1DH\s0 parameters is extremely time consuming, an application
 208 should not generate the parameters on the fly but supply the parameters.
 209 \&\s-1DH\s0 parameters can be reused, as the actual key is newly generated during
 210 the negotiation. The risk in reusing \s-1DH\s0 parameters is that an attacker
 211 may specialize on a very often used \s-1DH\s0 group. Applications should therefore
 212 generate their own \s-1DH\s0 parameters during the installation process using the
 213 openssl \fIdhparam\fR\|(1) application. In order to reduce the computer
 214 time needed for this generation, it is possible to use \s-1DSA\s0 parameters
 215 instead (see \fIdhparam\fR\|(1)), but in this case \s-1SSL_OP_SINGLE_DH_USE\s0
 216 is mandatory.
 217 .PP
 218 Application authors may compile in \s-1DH\s0 parameters. Files dh512.pem,
 219 dh1024.pem, dh2048.pem, and dh4096 in the 'apps' directory of current
 220 version of the OpenSSL distribution contain the '\s-1SKIP\s0' \s-1DH\s0 parameters,
 221 which use safe primes and were generated verifiably pseudo-randomly.
 222 These files can be converted into C code using the \fB\-C\fR option of the
 223 \&\fIdhparam\fR\|(1) application.
 224 Authors may also generate their own set of parameters using
 225 \&\fIdhparam\fR\|(1), but a user may not be sure how the parameters were
 226 generated. The generation of \s-1DH\s0 parameters during installation is therefore
 227 recommended.
 228 .PP
 229 An application may either directly specify the \s-1DH\s0 parameters or
 230 can supply the \s-1DH\s0 parameters via a callback function. The callback approach
 231 has the advantage, that the callback may supply \s-1DH\s0 parameters for different
 232 key lengths.
 233 .PP
 234 The \fBtmp_dh_callback\fR is called with the \fBkeylength\fR needed and
 235 the \fBis_export\fR information. The \fBis_export\fR flag is set, when the
 236 ephemeral \s-1DH\s0 key exchange is performed with an export cipher.
 237 .SH "EXAMPLES"
 238 .IX Header "EXAMPLES"
 239 Handle \s-1DH\s0 parameters for key lengths of 512 and 1024 bits. (Error handling
 240 partly left out.)
 241 .PP
 242 .Vb 5
 243 \& ...
 244 \& /* Set up ephemeral DH stuff */
 245 \& DH *dh_512 = NULL;
 246 \& DH *dh_1024 = NULL;
 247 \& FILE *paramfile;
 248 \&
 249 \& ...
 250 \& /* "openssl dhparam \-out dh_param_512.pem \-2 512" */
 251 \& paramfile = fopen("dh_param_512.pem", "r");
 252 \& if (paramfile) {
 253 \&   dh_512 = PEM_read_DHparams(paramfile, NULL, NULL, NULL);
 254 \&   fclose(paramfile);
 255 \& }
 256 \& /* "openssl dhparam \-out dh_param_1024.pem \-2 1024" */
 257 \& paramfile = fopen("dh_param_1024.pem", "r");
 258 \& if (paramfile) {
 259 \&   dh_1024 = PEM_read_DHparams(paramfile, NULL, NULL, NULL);
 260 \&   fclose(paramfile);
 261 \& }
 262 \& ...
 263 \&
 264 \& /* "openssl dhparam \-C \-2 512" etc... */
 265 \& DH *get_dh512() { ... }
 266 \& DH *get_dh1024() { ... }
 267 \&
 268 \& DH *tmp_dh_callback(SSL *s, int is_export, int keylength)
 269 \& {
 270 \&    DH *dh_tmp=NULL;
 271 \&
 272 \&    switch (keylength) {
 273 \&    case 512:
 274 \&      if (!dh_512)
 275 \&        dh_512 = get_dh512();
 276 \&      dh_tmp = dh_512;
 277 \&      break;
 278 \&    case 1024:
 279 \&      if (!dh_1024)
 280 \&        dh_1024 = get_dh1024();
 281 \&      dh_tmp = dh_1024;
 282 \&      break;
 283 \&    default:
 284 \&      /* Generating a key on the fly is very costly, so use what is there */
 285 \&      setup_dh_parameters_like_above();
 286 \&    }
 287 \&    return(dh_tmp);
 288 \& }
 289 .Ve
 290 .SH "RETURN VALUES"
 291 .IX Header "RETURN VALUES"
 292 \&\fISSL_CTX_set_tmp_dh_callback()\fR and \fISSL_set_tmp_dh_callback()\fR do not return
 293 diagnostic output.
 294 .PP
 295 \&\fISSL_CTX_set_tmp_dh()\fR and \fISSL_set_tmp_dh()\fR do return 1 on success and 0
 296 on failure. Check the error queue to find out the reason of failure.
 297 .SH "SEE ALSO"
 298 .IX Header "SEE ALSO"
 299 \&\fIssl\fR\|(3), \fISSL_CTX_set_cipher_list\fR\|(3),
 300 \&\fISSL_CTX_set_tmp_rsa_callback\fR\|(3),
 301 \&\fISSL_CTX_set_options\fR\|(3),
 302 \&\fIciphers\fR\|(1), \fIdhparam\fR\|(1)