secure/lib/libssl/man/SSL_CTX_set_generate_session_id.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_generate_session_id 3"
 135 .TH SSL_CTX_set_generate_session_id 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_generate_session_id, SSL_set_generate_session_id, SSL_has_matching_session_id \- manipulate generation of SSL session IDs (server only)
 142 .SH "SYNOPSIS"
 143 .IX Header "SYNOPSIS"
 144 .Vb 1
 145 \& #include <openssl/ssl.h>
 146 \&
 147 \& typedef int (*GEN_SESSION_CB)(const SSL *ssl, unsigned char *id,
 148 \&                               unsigned int *id_len);
 149 \&
 150 \& int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb);
 151 \& int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB, cb);
 152 \& int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
 153 \&                                 unsigned int id_len);
 154 .Ve
 155 .SH "DESCRIPTION"
 156 .IX Header "DESCRIPTION"
 157 \&\fISSL_CTX_set_generate_session_id()\fR sets the callback function for generating
 158 new session ids for \s-1SSL/TLS\s0 sessions for \fBctx\fR to be \fBcb\fR.
 159 .PP
 160 \&\fISSL_set_generate_session_id()\fR sets the callback function for generating
 161 new session ids for \s-1SSL/TLS\s0 sessions for \fBssl\fR to be \fBcb\fR.
 162 .PP
 163 \&\fISSL_has_matching_session_id()\fR checks, whether a session with id \fBid\fR
 164 (of length \fBid_len\fR) is already contained in the internal session cache
 165 of the parent context of \fBssl\fR.
 166 .SH "NOTES"
 167 .IX Header "NOTES"
 168 When a new session is established between client and server, the server
 169 generates a session id. The session id is an arbitrary sequence of bytes.
 170 The length of the session id is 16 bytes for SSLv2 sessions and between
 171 1 and 32 bytes for SSLv3/TLSv1. The session id is not security critical
 172 but must be unique for the server. Additionally, the session id is
 173 transmitted in the clear when reusing the session so it must not contain
 174 sensitive information.
 175 .PP
 176 Without a callback being set, an OpenSSL server will generate a unique
 177 session id from pseudo random numbers of the maximum possible length.
 178 Using the callback function, the session id can be changed to contain
 179 additional information like e.g. a host id in order to improve load balancing
 180 or external caching techniques.
 181 .PP
 182 The callback function receives a pointer to the memory location to put
 183 \&\fBid\fR into and a pointer to the maximum allowed length \fBid_len\fR. The
 184 buffer at location \fBid\fR is only guaranteed to have the size \fBid_len\fR.
 185 The callback is only allowed to generate a shorter id and reduce \fBid_len\fR;
 186 the callback \fBmust never\fR increase \fBid_len\fR or write to the location
 187 \&\fBid\fR exceeding the given limit.
 188 .PP
 189 If a SSLv2 session id is generated and \fBid_len\fR is reduced, it will be
 190 restored after the callback has finished and the session id will be padded
 191 with 0x00. It is not recommended to change the \fBid_len\fR for SSLv2 sessions.
 192 The callback can use the \fISSL_get_version\fR\|(3) function
 193 to check, whether the session is of type SSLv2.
 194 .PP
 195 The location \fBid\fR is filled with 0x00 before the callback is called, so the
 196 callback may only fill part of the possible length and leave \fBid_len\fR
 197 untouched while maintaining reproducibility.
 198 .PP
 199 Since the sessions must be distinguished, session ids must be unique.
 200 Without the callback a random number is used, so that the probability
 201 of generating the same session id is extremely small (2^128 possible ids
 202 for an SSLv2 session, 2^256 for SSLv3/TLSv1). In order to assure the
 203 uniqueness of the generated session id, the callback must call
 204 \&\fISSL_has_matching_session_id()\fR and generate another id if a conflict occurs.
 205 If an id conflict is not resolved, the handshake will fail.
 206 If the application codes e.g. a unique host id, a unique process number, and
 207 a unique sequence number into the session id, uniqueness could easily be
 208 achieved without randomness added (it should however be taken care that
 209 no confidential information is leaked this way). If the application can not
 210 guarantee uniqueness, it is recommended to use the maximum \fBid_len\fR and
 211 fill in the bytes not used to code special information with random data
 212 to avoid collisions.
 213 .PP
 214 \&\fISSL_has_matching_session_id()\fR will only query the internal session cache,
 215 not the external one. Since the session id is generated before the
 216 handshake is completed, it is not immediately added to the cache. If
 217 another thread is using the same internal session cache, a race condition
 218 can occur in that another thread generates the same session id.
 219 Collisions can also occur when using an external session cache, since
 220 the external cache is not tested with \fISSL_has_matching_session_id()\fR
 221 and the same race condition applies.
 222 .PP
 223 When calling \fISSL_has_matching_session_id()\fR for an SSLv2 session with
 224 reduced \fBid_len\fR, the match operation will be performed using the
 225 fixed length required and with a 0x00 padded id.
 226 .PP
 227 The callback must return 0 if it cannot generate a session id for whatever
 228 reason and return 1 on success.
 229 .SH "EXAMPLES"
 230 .IX Header "EXAMPLES"
 231 The callback function listed will generate a session id with the
 232 server id given, and will fill the rest with pseudo random bytes:
 233 .PP
 234 .Vb 1
 235 \& const char session_id_prefix = "www\-18";
 236 \&
 237 \& #define MAX_SESSION_ID_ATTEMPTS 10
 238 \& static int generate_session_id(const SSL *ssl, unsigned char *id,
 239 \&                              unsigned int *id_len)
 240 \&      {
 241 \&      unsigned int count = 0;
 242 \&      const char *version;
 243 \&
 244 \&      version = SSL_get_version(ssl);
 245 \&      if (!strcmp(version, "SSLv2"))
 246 \&          /* we must not change id_len */;
 247 \&
 248 \&      do      {
 249 \&              RAND_pseudo_bytes(id, *id_len);
 250 \&              /* Prefix the session_id with the required prefix. NB: If our
 251 \&               * prefix is too long, clip it \- but there will be worse effects
 252 \&               * anyway, eg. the server could only possibly create 1 session
 253 \&               * ID (ie. the prefix!) so all future session negotiations will
 254 \&               * fail due to conflicts. */
 255 \&              memcpy(id, session_id_prefix,
 256 \&                      (strlen(session_id_prefix) < *id_len) ?
 257 \&                      strlen(session_id_prefix) : *id_len);
 258 \&              }
 259 \&      while(SSL_has_matching_session_id(ssl, id, *id_len) &&
 260 \&              (++count < MAX_SESSION_ID_ATTEMPTS));
 261 \&      if(count >= MAX_SESSION_ID_ATTEMPTS)
 262 \&              return 0;
 263 \&      return 1;
 264 \&      }
 265 .Ve
 266 .SH "RETURN VALUES"
 267 .IX Header "RETURN VALUES"
 268 \&\fISSL_CTX_set_generate_session_id()\fR and \fISSL_set_generate_session_id()\fR
 269 always return 1.
 270 .PP
 271 \&\fISSL_has_matching_session_id()\fR returns 1 if another session with the
 272 same id is already in the cache.
 273 .SH "SEE ALSO"
 274 .IX Header "SEE ALSO"
 275 \&\fIssl\fR\|(3), \fISSL_get_version\fR\|(3)
 276 .SH "HISTORY"
 277 .IX Header "HISTORY"
 278 \&\fISSL_CTX_set_generate_session_id()\fR, \fISSL_set_generate_session_id()\fR
 279 and \fISSL_has_matching_session_id()\fR have been introduced in
 280 OpenSSL 0.9.7.