openssl: Adjust manual pages for 1.0.1m.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_tmp_rsa_callback.3
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
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 turned on, 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 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "SSL_CTX_set_tmp_rsa_callback 3"
136 .TH SSL_CTX_set_tmp_rsa_callback 3 "2015-03-19" "1.0.1m" "OpenSSL"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 SSL_CTX_set_tmp_rsa_callback, SSL_CTX_set_tmp_rsa, SSL_CTX_need_tmp_rsa, SSL_set_tmp_rsa_callback, SSL_set_tmp_rsa, SSL_need_tmp_rsa \- handle RSA keys for ephemeral key exchange
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 .Vb 1
146 \& #include <openssl/ssl.h>
147 \&
148 \& void SSL_CTX_set_tmp_rsa_callback(SSL_CTX *ctx,
149 \&            RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength));
150 \& long SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, RSA *rsa);
151 \& long SSL_CTX_need_tmp_rsa(SSL_CTX *ctx);
152 \&
153 \& void SSL_set_tmp_rsa_callback(SSL_CTX *ctx,
154 \&            RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength));
155 \& long SSL_set_tmp_rsa(SSL *ssl, RSA *rsa)
156 \& long SSL_need_tmp_rsa(SSL *ssl)
157 \&
158 \& RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength);
159 .Ve
160 .SH "DESCRIPTION"
161 .IX Header "DESCRIPTION"
162 \&\fISSL_CTX_set_tmp_rsa_callback()\fR sets the callback function for \fBctx\fR to be
163 used when a temporary/ephemeral \s-1RSA\s0 key is required to \fBtmp_rsa_callback\fR.
164 The callback is inherited by all \s-1SSL\s0 objects newly created from \fBctx\fR
165 with <\fISSL_new\fR\|(3)|\fISSL_new\fR\|(3)>. Already created \s-1SSL\s0 objects are not affected.
166 .PP
167 \&\fISSL_CTX_set_tmp_rsa()\fR sets the temporary/ephemeral \s-1RSA\s0 key to be used to be
168 \&\fBrsa\fR. The key is inherited by all \s-1SSL\s0 objects newly created from \fBctx\fR
169 with <\fISSL_new\fR\|(3)|\fISSL_new\fR\|(3)>. Already created \s-1SSL\s0 objects are not affected.
170 .PP
171 \&\fISSL_CTX_need_tmp_rsa()\fR returns 1, if a temporary/ephemeral \s-1RSA\s0 key is needed
172 for RSA-based strength-limited 'exportable' ciphersuites because a \s-1RSA\s0 key
173 with a keysize larger than 512 bits is installed.
174 .PP
175 \&\fISSL_set_tmp_rsa_callback()\fR sets the callback only for \fBssl\fR.
176 .PP
177 \&\fISSL_set_tmp_rsa()\fR sets the key only for \fBssl\fR.
178 .PP
179 \&\fISSL_need_tmp_rsa()\fR returns 1, if a temporary/ephemeral \s-1RSA\s0 key is needed,
180 for RSA-based strength-limited 'exportable' ciphersuites because a \s-1RSA\s0 key
181 with a keysize larger than 512 bits is installed.
182 .PP
183 These functions apply to \s-1SSL/TLS\s0 servers only.
184 .SH "NOTES"
185 .IX Header "NOTES"
186 When using a cipher with \s-1RSA\s0 authentication, an ephemeral \s-1RSA\s0 key exchange
187 can take place. In this case the session data are negotiated using the
188 ephemeral/temporary \s-1RSA\s0 key and the \s-1RSA\s0 key supplied and certified
189 by the certificate chain is only used for signing.
190 .PP
191 Under previous export restrictions, ciphers with \s-1RSA\s0 keys shorter (512 bits)
192 than the usual key length of 1024 bits were created. To use these ciphers
193 with \s-1RSA\s0 keys of usual length, an ephemeral key exchange must be performed,
194 as the normal (certified) key cannot be directly used.
195 .PP
196 Using ephemeral \s-1RSA\s0 key exchange yields forward secrecy, as the connection
197 can only be decrypted, when the \s-1RSA\s0 key is known. By generating a temporary
198 \&\s-1RSA\s0 key inside the server application that is lost when the application
199 is left, it becomes impossible for an attacker to decrypt past sessions,
200 even if he gets hold of the normal (certified) \s-1RSA\s0 key, as this key was
201 used for signing only. The downside is that creating a \s-1RSA\s0 key is
202 computationally expensive.
203 .PP
204 Additionally, the use of ephemeral \s-1RSA\s0 key exchange is only allowed in
205 the \s-1TLS\s0 standard, when the \s-1RSA\s0 key can be used for signing only, that is
206 for export ciphers. Using ephemeral \s-1RSA\s0 key exchange for other purposes
207 violates the standard and can break interoperability with clients.
208 It is therefore strongly recommended to not use ephemeral \s-1RSA\s0 key
209 exchange and use \s-1EDH \s0(Ephemeral Diffie-Hellman) key exchange instead
210 in order to achieve forward secrecy (see
211 \&\fISSL_CTX_set_tmp_dh_callback\fR\|(3)).
212 .PP
213 An application may either directly specify the key or can supply the key via a
214 callback function. The callback approach has the advantage, that the callback
215 may generate the key only in case it is actually needed. As the generation of a
216 \&\s-1RSA\s0 key is however costly, it will lead to a significant delay in the handshake
217 procedure.  Another advantage of the callback function is that it can supply
218 keys of different size while the explicit setting of the key is only useful for
219 key size of 512 bits to satisfy the export restricted ciphers and does give
220 away key length if a longer key would be allowed.
221 .PP
222 The \fBtmp_rsa_callback\fR is called with the \fBkeylength\fR needed and
223 the \fBis_export\fR information. The \fBis_export\fR flag is set, when the
224 ephemeral \s-1RSA\s0 key exchange is performed with an export cipher.
225 .SH "EXAMPLES"
226 .IX Header "EXAMPLES"
227 Generate temporary \s-1RSA\s0 keys to prepare ephemeral \s-1RSA\s0 key exchange. As the
228 generation of a \s-1RSA\s0 key costs a lot of computer time, they saved for later
229 reuse. For demonstration purposes, two keys for 512 bits and 1024 bits
230 respectively are generated.
231 .PP
232 .Vb 4
233 \& ...
234 \& /* Set up ephemeral RSA stuff */
235 \& RSA *rsa_512 = NULL;
236 \& RSA *rsa_1024 = NULL;
237 \&
238 \& rsa_512 = RSA_generate_key(512,RSA_F4,NULL,NULL);
239 \& if (rsa_512 == NULL)
240 \&     evaluate_error_queue();
241 \&
242 \& rsa_1024 = RSA_generate_key(1024,RSA_F4,NULL,NULL);
243 \& if (rsa_1024 == NULL)
244 \&   evaluate_error_queue();
245 \&
246 \& ...
247 \&
248 \& RSA *tmp_rsa_callback(SSL *s, int is_export, int keylength)
249 \& {
250 \&    RSA *rsa_tmp=NULL;
251 \&
252 \&    switch (keylength) {
253 \&    case 512:
254 \&      if (rsa_512)
255 \&        rsa_tmp = rsa_512;
256 \&      else { /* generate on the fly, should not happen in this example */
257 \&        rsa_tmp = RSA_generate_key(keylength,RSA_F4,NULL,NULL);
258 \&        rsa_512 = rsa_tmp; /* Remember for later reuse */
259 \&      }
260 \&      break;
261 \&    case 1024:
262 \&      if (rsa_1024)
263 \&        rsa_tmp=rsa_1024;
264 \&      else
265 \&        should_not_happen_in_this_example();
266 \&      break;
267 \&    default:
268 \&      /* Generating a key on the fly is very costly, so use what is there */
269 \&      if (rsa_1024)
270 \&        rsa_tmp=rsa_1024;
271 \&      else
272 \&        rsa_tmp=rsa_512; /* Use at least a shorter key */
273 \&    }
274 \&    return(rsa_tmp);
275 \& }
276 .Ve
277 .SH "RETURN VALUES"
278 .IX Header "RETURN VALUES"
279 \&\fISSL_CTX_set_tmp_rsa_callback()\fR and \fISSL_set_tmp_rsa_callback()\fR do not return
280 diagnostic output.
281 .PP
282 \&\fISSL_CTX_set_tmp_rsa()\fR and \fISSL_set_tmp_rsa()\fR do return 1 on success and 0
283 on failure. Check the error queue to find out the reason of failure.
284 .PP
285 \&\fISSL_CTX_need_tmp_rsa()\fR and \fISSL_need_tmp_rsa()\fR return 1 if a temporary
286 \&\s-1RSA\s0 key is needed and 0 otherwise.
287 .SH "SEE ALSO"
288 .IX Header "SEE ALSO"
289 \&\fIssl\fR\|(3), \fISSL_CTX_set_cipher_list\fR\|(3),
290 \&\fISSL_CTX_set_options\fR\|(3),
291 \&\fISSL_CTX_set_tmp_dh_callback\fR\|(3),
292 \&\fISSL_new\fR\|(3), \fIciphers\fR\|(1)