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