secure/lib/libssl/man/SSL_CTX_set_tmp_rsa_callback.3

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