secure/lib/libssl/man/SSL_CTX_set_tmp_rsa_callback.3

   1 .\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.35)
   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 >0, 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 .if !\nF .nr F 0
  58 .if \nF>0 \{\
  59 .    de IX
  60 .    tm Index:\\$1\t\\n%\t"\\$2"
  61 ..
  62 .    if !\nF==2 \{\
  63 .        nr % 0
  64 .        nr F 2
  65 .    \}
  66 .\}
  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_rsa_callback 3"
 132 .TH SSL_CTX_set_tmp_rsa_callback 3 "2017-11-02" "1.0.2m" "OpenSSL"
 133 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 134 .\" way too many mistakes in technical documents.
 135 .if n .ad l
 136 .nh
 137 .SH "NAME"
 138 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
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& void SSL_CTX_set_tmp_rsa_callback(SSL_CTX *ctx,
 145 \&            RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength));
 146 \& long SSL_CTX_set_tmp_rsa(SSL_CTX *ctx, RSA *rsa);
 147 \& long SSL_CTX_need_tmp_rsa(SSL_CTX *ctx);
 148 \&
 149 \& void SSL_set_tmp_rsa_callback(SSL_CTX *ctx,
 150 \&            RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength));
 151 \& long SSL_set_tmp_rsa(SSL *ssl, RSA *rsa)
 152 \& long SSL_need_tmp_rsa(SSL *ssl)
 153 \&
 154 \& RSA *(*tmp_rsa_callback)(SSL *ssl, int is_export, int keylength);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fISSL_CTX_set_tmp_rsa_callback()\fR sets the callback function for \fBctx\fR to be
 159 used when a temporary/ephemeral \s-1RSA\s0 key is required to \fBtmp_rsa_callback\fR.
 160 The callback is inherited by all \s-1SSL\s0 objects newly created from \fBctx\fR
 161 with <\fISSL_new\fR\|(3)|\fISSL_new\fR\|(3)>. Already created \s-1SSL\s0 objects are not affected.
 162 .PP
 163 \&\fISSL_CTX_set_tmp_rsa()\fR sets the temporary/ephemeral \s-1RSA\s0 key to be used to be
 164 \&\fBrsa\fR. The key 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_need_tmp_rsa()\fR returns 1, if a temporary/ephemeral \s-1RSA\s0 key is needed
 168 for RSA-based strength-limited 'exportable' ciphersuites because a \s-1RSA\s0 key
 169 with a keysize larger than 512 bits is installed.
 170 .PP
 171 \&\fISSL_set_tmp_rsa_callback()\fR sets the callback only for \fBssl\fR.
 172 .PP
 173 \&\fISSL_set_tmp_rsa()\fR sets the key only for \fBssl\fR.
 174 .PP
 175 \&\fISSL_need_tmp_rsa()\fR returns 1, if a temporary/ephemeral \s-1RSA\s0 key is needed,
 176 for RSA-based strength-limited 'exportable' ciphersuites because a \s-1RSA\s0 key
 177 with a keysize larger than 512 bits is installed.
 178 .PP
 179 These functions apply to \s-1SSL/TLS\s0 servers only.
 180 .SH "NOTES"
 181 .IX Header "NOTES"
 182 When using a cipher with \s-1RSA\s0 authentication, an ephemeral \s-1RSA\s0 key exchange
 183 can take place. In this case the session data are negotiated using the
 184 ephemeral/temporary \s-1RSA\s0 key and the \s-1RSA\s0 key supplied and certified
 185 by the certificate chain is only used for signing.
 186 .PP
 187 Under previous export restrictions, ciphers with \s-1RSA\s0 keys shorter (512 bits)
 188 than the usual key length of 1024 bits were created. To use these ciphers
 189 with \s-1RSA\s0 keys of usual length, an ephemeral key exchange must be performed,
 190 as the normal (certified) key cannot be directly used.
 191 .PP
 192 Using ephemeral \s-1RSA\s0 key exchange yields forward secrecy, as the connection
 193 can only be decrypted, when the \s-1RSA\s0 key is known. By generating a temporary
 194 \&\s-1RSA\s0 key inside the server application that is lost when the application
 195 is left, it becomes impossible for an attacker to decrypt past sessions,
 196 even if he gets hold of the normal (certified) \s-1RSA\s0 key, as this key was
 197 used for signing only. The downside is that creating a \s-1RSA\s0 key is
 198 computationally expensive.
 199 .PP
 200 Additionally, the use of ephemeral \s-1RSA\s0 key exchange is only allowed in
 201 the \s-1TLS\s0 standard, when the \s-1RSA\s0 key can be used for signing only, that is
 202 for export ciphers. Using ephemeral \s-1RSA\s0 key exchange for other purposes
 203 violates the standard and can break interoperability with clients.
 204 It is therefore strongly recommended to not use ephemeral \s-1RSA\s0 key
 205 exchange and use \s-1DHE \s0(Ephemeral Diffie-Hellman) key exchange instead
 206 in order to achieve forward secrecy (see
 207 \&\fISSL_CTX_set_tmp_dh_callback\fR\|(3)).
 208 .PP
 209 An application may either directly specify the key or can supply the key via a
 210 callback function. The callback approach has the advantage, that the callback
 211 may generate the key only in case it is actually needed. As the generation of a
 212 \&\s-1RSA\s0 key is however costly, it will lead to a significant delay in the handshake
 213 procedure.  Another advantage of the callback function is that it can supply
 214 keys of different size while the explicit setting of the key is only useful for
 215 key size of 512 bits to satisfy the export restricted ciphers and does give
 216 away key length if a longer key would be allowed.
 217 .PP
 218 The \fBtmp_rsa_callback\fR is called with the \fBkeylength\fR needed and
 219 the \fBis_export\fR information. The \fBis_export\fR flag is set, when the
 220 ephemeral \s-1RSA\s0 key exchange is performed with an export cipher.
 221 .SH "EXAMPLES"
 222 .IX Header "EXAMPLES"
 223 Generate temporary \s-1RSA\s0 keys to prepare ephemeral \s-1RSA\s0 key exchange. As the
 224 generation of a \s-1RSA\s0 key costs a lot of computer time, they saved for later
 225 reuse. For demonstration purposes, two keys for 512 bits and 1024 bits
 226 respectively are generated.
 227 .PP
 228 .Vb 4
 229 \& ...
 230 \& /* Set up ephemeral RSA stuff */
 231 \& RSA *rsa_512 = NULL;
 232 \& RSA *rsa_1024 = NULL;
 233 \&
 234 \& rsa_512 = RSA_generate_key(512,RSA_F4,NULL,NULL);
 235 \& if (rsa_512 == NULL)
 236 \&     evaluate_error_queue();
 237 \&
 238 \& rsa_1024 = RSA_generate_key(1024,RSA_F4,NULL,NULL);
 239 \& if (rsa_1024 == NULL)
 240 \&   evaluate_error_queue();
 241 \&
 242 \& ...
 243 \&
 244 \& RSA *tmp_rsa_callback(SSL *s, int is_export, int keylength)
 245 \& {
 246 \&    RSA *rsa_tmp=NULL;
 247 \&
 248 \&    switch (keylength) {
 249 \&    case 512:
 250 \&      if (rsa_512)
 251 \&        rsa_tmp = rsa_512;
 252 \&      else { /* generate on the fly, should not happen in this example */
 253 \&        rsa_tmp = RSA_generate_key(keylength,RSA_F4,NULL,NULL);
 254 \&        rsa_512 = rsa_tmp; /* Remember for later reuse */
 255 \&      }
 256 \&      break;
 257 \&    case 1024:
 258 \&      if (rsa_1024)
 259 \&        rsa_tmp=rsa_1024;
 260 \&      else
 261 \&        should_not_happen_in_this_example();
 262 \&      break;
 263 \&    default:
 264 \&      /* Generating a key on the fly is very costly, so use what is there */
 265 \&      if (rsa_1024)
 266 \&        rsa_tmp=rsa_1024;
 267 \&      else
 268 \&        rsa_tmp=rsa_512; /* Use at least a shorter key */
 269 \&    }
 270 \&    return(rsa_tmp);
 271 \& }
 272 .Ve
 273 .SH "RETURN VALUES"
 274 .IX Header "RETURN VALUES"
 275 \&\fISSL_CTX_set_tmp_rsa_callback()\fR and \fISSL_set_tmp_rsa_callback()\fR do not return
 276 diagnostic output.
 277 .PP
 278 \&\fISSL_CTX_set_tmp_rsa()\fR and \fISSL_set_tmp_rsa()\fR do return 1 on success and 0
 279 on failure. Check the error queue to find out the reason of failure.
 280 .PP
 281 \&\fISSL_CTX_need_tmp_rsa()\fR and \fISSL_need_tmp_rsa()\fR return 1 if a temporary
 282 \&\s-1RSA\s0 key is needed and 0 otherwise.
 283 .SH "SEE ALSO"
 284 .IX Header "SEE ALSO"
 285 \&\fIssl\fR\|(3), \fISSL_CTX_set_cipher_list\fR\|(3),
 286 \&\fISSL_CTX_set_options\fR\|(3),
 287 \&\fISSL_CTX_set_tmp_dh_callback\fR\|(3),
 288 \&\fISSL_new\fR\|(3), \fIciphers\fR\|(1)