secure/lib/libssl/man/SSL_CTX_set_tmp_dh_callback.3

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
   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.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  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 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  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 "2008-09-27" "0.9.8i" "OpenSSL"
 133 .SH "NAME"
 134 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
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \& #include <openssl/ssl.h>
 139 .Ve
 140 .PP
 141 .Vb 3
 142 \& void SSL_CTX_set_tmp_dh_callback(SSL_CTX *ctx,
 143 \&            DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
 144 \& long SSL_CTX_set_tmp_dh(SSL_CTX *ctx, DH *dh);
 145 .Ve
 146 .PP
 147 .Vb 3
 148 \& void SSL_set_tmp_dh_callback(SSL_CTX *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 .PP
 153 .Vb 1
 154 \& DH *(*tmp_dh_callback)(SSL *ssl, int is_export, int keylength));
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fISSL_CTX_set_tmp_dh_callback()\fR sets the callback function for \fBctx\fR to be
 159 used when a \s-1DH\s0 parameters are required to \fBtmp_dh_callback\fR.
 160 The callback is inherited by all \fBssl\fR objects created from \fBctx\fR.
 161 .PP
 162 \&\fISSL_CTX_set_tmp_dh()\fR sets \s-1DH\s0 parameters to be used to be \fBdh\fR.
 163 The key is inherited by all \fBssl\fR objects created from \fBctx\fR.
 164 .PP
 165 \&\fISSL_set_tmp_dh_callback()\fR sets the callback only for \fBssl\fR.
 166 .PP
 167 \&\fISSL_set_tmp_dh()\fR sets the parameters only for \fBssl\fR.
 168 .PP
 169 These functions apply to \s-1SSL/TLS\s0 servers only.
 170 .SH "NOTES"
 171 .IX Header "NOTES"
 172 When using a cipher with \s-1RSA\s0 authentication, an ephemeral \s-1DH\s0 key exchange
 173 can take place. Ciphers with \s-1DSA\s0 keys always use ephemeral \s-1DH\s0 keys as well.
 174 In these cases, the session data are negotiated using the
 175 ephemeral/temporary \s-1DH\s0 key and the key supplied and certified
 176 by the certificate chain is only used for signing.
 177 Anonymous ciphers (without a permanent server key) also use ephemeral \s-1DH\s0 keys.
 178 .PP
 179 Using ephemeral \s-1DH\s0 key exchange yields forward secrecy, as the connection
 180 can only be decrypted, when the \s-1DH\s0 key is known. By generating a temporary
 181 \&\s-1DH\s0 key inside the server application that is lost when the application
 182 is left, it becomes impossible for an attacker to decrypt past sessions,
 183 even if he gets hold of the normal (certified) key, as this key was
 184 only used for signing.
 185 .PP
 186 In order to perform a \s-1DH\s0 key exchange the server must use a \s-1DH\s0 group
 187 (\s-1DH\s0 parameters) and generate a \s-1DH\s0 key. The server will always generate a new
 188 \&\s-1DH\s0 key during the negotiation, when the \s-1DH\s0 parameters are supplied via
 189 callback and/or when the \s-1SSL_OP_SINGLE_DH_USE\s0 option of
 190 \&\fISSL_CTX_set_options\fR\|(3) is set. It will
 191 immediately create a \s-1DH\s0 key, when \s-1DH\s0 parameters are supplied via
 192 \&\fISSL_CTX_set_tmp_dh()\fR and \s-1SSL_OP_SINGLE_DH_USE\s0 is not set. In this case,
 193 it may happen that a key is generated on initialization without later
 194 being needed, while on the other hand the computer time during the
 195 negotiation is being saved.
 196 .PP
 197 If \*(L"strong\*(R" primes were used to generate the \s-1DH\s0 parameters, it is not strictly
 198 necessary to generate a new key for each handshake but it does improve forward
 199 secrecy. If it is not assured, that \*(L"strong\*(R" primes were used (see especially
 200 the section about \s-1DSA\s0 parameters below), \s-1SSL_OP_SINGLE_DH_USE\s0 must be used
 201 in order to prevent small subgroup attacks. Always using \s-1SSL_OP_SINGLE_DH_USE\s0
 202 has an impact on the computer time needed during negotiation, but it is not
 203 very large, so application authors/users should consider to always enable
 204 this option.
 205 .PP
 206 As generating \s-1DH\s0 parameters is extremely time consuming, an application
 207 should not generate the parameters on the fly but supply the parameters.
 208 \&\s-1DH\s0 parameters can be reused, as the actual key is newly generated during
 209 the negotiation. The risk in reusing \s-1DH\s0 parameters is that an attacker
 210 may specialize on a very often used \s-1DH\s0 group. Applications should therefore
 211 generate their own \s-1DH\s0 parameters during the installation process using the
 212 openssl \fIdhparam\fR\|(1) application. In order to reduce the computer
 213 time needed for this generation, it is possible to use \s-1DSA\s0 parameters
 214 instead (see \fIdhparam\fR\|(1)), but in this case \s-1SSL_OP_SINGLE_DH_USE\s0
 215 is mandatory.
 216 .PP
 217 Application authors may compile in \s-1DH\s0 parameters. Files dh512.pem,
 218 dh1024.pem, dh2048.pem, and dh4096 in the 'apps' directory of current
 219 version of the OpenSSL distribution contain the '\s-1SKIP\s0' \s-1DH\s0 parameters,
 220 which use safe primes and were generated verifiably pseudo\-randomly.
 221 These files can be converted into C code using the \fB\-C\fR option of the
 222 \&\fIdhparam\fR\|(1) application.
 223 Authors may also generate their own set of parameters using
 224 \&\fIdhparam\fR\|(1), but a user may not be sure how the parameters were
 225 generated. The generation of \s-1DH\s0 parameters during installation is therefore
 226 recommended.
 227 .PP
 228 An application may either directly specify the \s-1DH\s0 parameters or
 229 can supply the \s-1DH\s0 parameters via a callback function. The callback approach
 230 has the advantage, that the callback may supply \s-1DH\s0 parameters for different
 231 key lengths.
 232 .PP
 233 The \fBtmp_dh_callback\fR is called with the \fBkeylength\fR needed and
 234 the \fBis_export\fR information. The \fBis_export\fR flag is set, when the
 235 ephemeral \s-1DH\s0 key exchange is performed with an export cipher.
 236 .SH "EXAMPLES"
 237 .IX Header "EXAMPLES"
 238 Handle \s-1DH\s0 parameters for key lengths of 512 and 1024 bits. (Error handling
 239 partly left out.)
 240 .PP
 241 .Vb 5
 242 \& ...
 243 \& /* Set up ephemeral DH stuff */
 244 \& DH *dh_512 = NULL;
 245 \& DH *dh_1024 = NULL;
 246 \& FILE *paramfile;
 247 .Ve
 248 .PP
 249 .Vb 14
 250 \& ...
 251 \& /* "openssl dhparam -out dh_param_512.pem -2 512" */
 252 \& paramfile = fopen("dh_param_512.pem", "r");
 253 \& if (paramfile) {
 254 \&   dh_512 = PEM_read_DHparams(paramfile, NULL, NULL, NULL);
 255 \&   fclose(paramfile);
 256 \& }
 257 \& /* "openssl dhparam -out dh_param_1024.pem -2 1024" */
 258 \& paramfile = fopen("dh_param_1024.pem", "r");
 259 \& if (paramfile) {
 260 \&   dh_1024 = PEM_read_DHparams(paramfile, NULL, NULL, NULL);
 261 \&   fclose(paramfile);
 262 \& }
 263 \& ...
 264 .Ve
 265 .PP
 266 .Vb 3
 267 \& /* "openssl dhparam -C -2 512" etc... */
 268 \& DH *get_dh512() { ... }
 269 \& DH *get_dh1024() { ... }
 270 .Ve
 271 .PP
 272 .Vb 3
 273 \& DH *tmp_dh_callback(SSL *s, int is_export, int keylength)
 274 \& {
 275 \&    DH *dh_tmp=NULL;
 276 .Ve
 277 .PP
 278 .Vb 17
 279 \&    switch (keylength) {
 280 \&    case 512:
 281 \&      if (!dh_512)
 282 \&        dh_512 = get_dh512();
 283 \&      dh_tmp = dh_512;
 284 \&      break;
 285 \&    case 1024:
 286 \&      if (!dh_1024)
 287 \&        dh_1024 = get_dh1024();
 288 \&      dh_tmp = dh_1024;
 289 \&      break;
 290 \&    default:
 291 \&      /* Generating a key on the fly is very costly, so use what is there */
 292 \&      setup_dh_parameters_like_above();
 293 \&    }
 294 \&    return(dh_tmp);
 295 \& }
 296 .Ve
 297 .SH "RETURN VALUES"
 298 .IX Header "RETURN VALUES"
 299 \&\fISSL_CTX_set_tmp_dh_callback()\fR and \fISSL_set_tmp_dh_callback()\fR do not return
 300 diagnostic output.
 301 .PP
 302 \&\fISSL_CTX_set_tmp_dh()\fR and \fISSL_set_tmp_dh()\fR do return 1 on success and 0
 303 on failure. Check the error queue to find out the reason of failure.
 304 .SH "SEE ALSO"
 305 .IX Header "SEE ALSO"
 306 \&\fIssl\fR\|(3), \fISSL_CTX_set_cipher_list\fR\|(3),
 307 \&\fISSL_CTX_set_tmp_rsa_callback\fR\|(3),
 308 \&\fISSL_CTX_set_options\fR\|(3),
 309 \&\fIciphers\fR\|(1), \fIdhparam\fR\|(1)