secure/lib/libssl/man/SSL_CTX_set_tmp_rsa_callback.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:47:43 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_rsa_callback 3"
 141 .TH SSL_CTX_set_tmp_rsa_callback 3 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 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 \s-1RSA\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 4
 151 \& void SSL_CTX_set_tmp_rsa_callback(SSL_CTX *ctx,
 152 \&            RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength));
 153 \& long SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, RSA *rsa);
 154 \& long SSL_CTX_need_tmp_rsa(SSL_CTX *ctx);
 155 .Ve
 156 .Vb 4
 157 \& void SSL_set_tmp_rsa_callback(SSL_CTX *ctx,
 158 \&            RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength));
 159 \& long SSL_set_tmp_rsa(SSL *ssl, RSA *rsa)
 160 \& long SSL_need_tmp_rsa(SSL *ssl)
 161 .Ve
 162 .Vb 1
 163 \& RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength));
 164 .Ve
 165 .SH "DESCRIPTION"
 166 .IX Header "DESCRIPTION"
 167 \&\fISSL_CTX_set_tmp_rsa_callback()\fR sets the callback function for \fBctx\fR to be
 168 used when a temporary/ephemeral \s-1RSA\s0 key is required to \fBtmp_rsa_callback\fR.
 169 The callback is inherited by all \s-1SSL\s0 objects newly created from \fBctx\fR
 170 with <\fISSL_new\fR\|(3)|\fISSL_new\fR\|(3)>. Already created \s-1SSL\s0 objects are not affected.
 171 .PP
 172 \&\fISSL_CTX_set_tmp_rsa()\fR sets the temporary/ephemeral \s-1RSA\s0 key to be used to be
 173 \&\fBrsa\fR. The key is inherited by all \s-1SSL\s0 objects newly created from \fBctx\fR
 174 with <\fISSL_new\fR\|(3)|\fISSL_new\fR\|(3)>. Already created \s-1SSL\s0 objects are not affected.
 175 .PP
 176 \&\fISSL_CTX_need_tmp_rsa()\fR returns 1, if a temporary/ephemeral \s-1RSA\s0 key is needed
 177 for RSA-based strength-limited 'exportable' ciphersuites because a \s-1RSA\s0 key
 178 with a keysize larger than 512 bits is installed.
 179 .PP
 180 \&\fISSL_set_tmp_rsa_callback()\fR sets the callback only for \fBssl\fR.
 181 .PP
 182 \&\fISSL_set_tmp_rsa()\fR sets the key only for \fBssl\fR.
 183 .PP
 184 \&\fISSL_need_tmp_rsa()\fR returns 1, if a temporary/ephemeral \s-1RSA\s0 key is needed,
 185 for RSA-based strength-limited 'exportable' ciphersuites because a \s-1RSA\s0 key
 186 with a keysize larger than 512 bits is installed.
 187 .PP
 188 These functions apply to \s-1SSL/TLS\s0 servers only.
 189 .SH "NOTES"
 190 .IX Header "NOTES"
 191 When using a cipher with \s-1RSA\s0 authentication, an ephemeral \s-1RSA\s0 key exchange
 192 can take place. In this case the session data are negotiated using the
 193 ephemeral/temporary \s-1RSA\s0 key and the \s-1RSA\s0 key supplied and certified
 194 by the certificate chain is only used for signing.
 195 .PP
 196 Under previous export restrictions, ciphers with \s-1RSA\s0 keys shorter (512 bits)
 197 than the usual key length of 1024 bits were created. To use these ciphers
 198 with \s-1RSA\s0 keys of usual length, an ephemeral key exchange must be performed,
 199 as the normal (certified) key cannot be directly used.
 200 .PP
 201 Using ephemeral \s-1RSA\s0 key exchange yields forward secrecy, as the connection
 202 can only be decrypted, when the \s-1RSA\s0 key is known. By generating a temporary
 203 \&\s-1RSA\s0 key inside the server application that is lost when the application
 204 is left, it becomes impossible for an attacker to decrypt past sessions,
 205 even if he gets hold of the normal (certified) \s-1RSA\s0 key, as this key was
 206 used for signing only. The downside is that creating a \s-1RSA\s0 key is
 207 computationally expensive.
 208 .PP
 209 Additionally, the use of ephemeral \s-1RSA\s0 key exchange is only allowed in
 210 the \s-1TLS\s0 standard, when the \s-1RSA\s0 key can be used for signing only, that is
 211 for export ciphers. Using ephemeral \s-1RSA\s0 key exchange for other purposes
 212 violates the standard and can break interoperability with clients.
 213 It is therefore strongly recommended to not use ephemeral \s-1RSA\s0 key
 214 exchange and use \s-1EDH\s0 (Ephemeral Diffie-Hellman) key exchange instead
 215 in order to achieve forward secrecy (see
 216 SSL_CTX_set_tmp_dh_callback(3)).
 217 .PP
 218 On OpenSSL servers ephemeral \s-1RSA\s0 key exchange is therefore disabled by default
 219 and must be explicitly enabled  using the \s-1SSL_OP_EPHEMERAL_RSA\s0 option of
 220 SSL_CTX_set_options(3), violating the \s-1TLS/SSL\s0
 221 standard. When ephemeral \s-1RSA\s0 key exchange is required for export ciphers,
 222 it will automatically be used without this option!
 223 .PP
 224 An application may either directly specify the key or can supply the key via
 225 a callback function. The callback approach has the advantage, that the
 226 callback may generate the key only in case it is actually needed. As the
 227 generation of a \s-1RSA\s0 key is however costly, it will lead to a significant
 228 delay in the handshake procedure.  Another advantage of the callback function
 229 is that it can supply keys of different size (e.g. for \s-1SSL_OP_EPHEMERAL_RSA\s0
 230 usage) while the explicit setting of the key is only useful for key size of
 231 512 bits to satisfy the export restricted ciphers and does give away key length
 232 if a longer key would be allowed.
 233 .PP
 234 The \fBtmp_rsa_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-1RSA\s0 key exchange is performed with an export cipher.
 237 .SH "EXAMPLES"
 238 .IX Header "EXAMPLES"
 239 Generate temporary \s-1RSA\s0 keys to prepare ephemeral \s-1RSA\s0 key exchange. As the
 240 generation of a \s-1RSA\s0 key costs a lot of computer time, they saved for later
 241 reuse. For demonstration purposes, two keys for 512 bits and 1024 bits
 242 respectively are generated.
 243 .PP
 244 .Vb 4
 245 \& ...
 246 \& /* Set up ephemeral RSA stuff */
 247 \& RSA *rsa_512 = NULL;
 248 \& RSA *rsa_1024 = NULL;
 249 .Ve
 250 .Vb 3
 251 \& rsa_512 = RSA_generate_key(512,RSA_F4,NULL,NULL);
 252 \& if (rsa_512 == NULL)
 253 \&     evaluate_error_queue();
 254 .Ve
 255 .Vb 3
 256 \& rsa_1024 = RSA_generate_key(1024,RSA_F4,NULL,NULL);
 257 \& if (rsa_1024 == NULL)
 258 \&   evaluate_error_queue();
 259 .Ve
 260 .Vb 1
 261 \& ...
 262 .Ve
 263 .Vb 3
 264 \& RSA *tmp_rsa_callback(SSL *s, int is_export, int keylength)
 265 \& {
 266 \&    RSA *rsa_tmp=NULL;
 267 .Ve
 268 .Vb 24
 269 \&    switch (keylength) {
 270 \&    case 512:
 271 \&      if (rsa_512)
 272 \&        rsa_tmp = rsa_512;
 273 \&      else { /* generate on the fly, should not happen in this example */
 274 \&        rsa_tmp = RSA_generate_key(keylength,RSA_F4,NULL,NULL);
 275 \&        rsa_512 = rsa_tmp; /* Remember for later reuse */
 276 \&      }
 277 \&      break;
 278 \&    case 1024:
 279 \&      if (rsa_1024)
 280 \&        rsa_tmp=rsa_1024;
 281 \&      else
 282 \&        should_not_happen_in_this_example();
 283 \&      break;
 284 \&    default:
 285 \&      /* Generating a key on the fly is very costly, so use what is there */
 286 \&      if (rsa_1024)
 287 \&        rsa_tmp=rsa_1024;
 288 \&      else
 289 \&        rsa_tmp=rsa_512; /* Use at least a shorter key */
 290 \&    }
 291 \&    return(rsa_tmp);
 292 \& }
 293 .Ve
 294 .SH "RETURN VALUES"
 295 .IX Header "RETURN VALUES"
 296 \&\fISSL_CTX_set_tmp_rsa_callback()\fR and \fISSL_set_tmp_rsa_callback()\fR do not return
 297 diagnostic output.
 298 .PP
 299 \&\fISSL_CTX_set_tmp_rsa()\fR and \fISSL_set_tmp_rsa()\fR do return 1 on success and 0
 300 on failure. Check the error queue to find out the reason of failure.
 301 .PP
 302 \&\fISSL_CTX_need_tmp_rsa()\fR and \fISSL_need_tmp_rsa()\fR return 1 if a temporary
 303 \&\s-1RSA\s0 key is needed and 0 otherwise.
 304 .SH "SEE ALSO"
 305 .IX Header "SEE ALSO"
 306 ssl(3), SSL_CTX_set_cipher_list(3),
 307 SSL_CTX_set_options(3),
 308 SSL_CTX_set_tmp_dh_callback(3),
 309 SSL_new(3), ciphers(1)