secure/lib/libssl/man/SSL_CTX_set_tmp_dh_callback.3

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