Update files for OpenSSL-1.0.0f import.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_generate_session_id.3
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.19)
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 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "SSL_CTX_set_generate_session_id 3"
127 .TH SSL_CTX_set_generate_session_id 3 "2012-01-04" "1.0.0f" "OpenSSL"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 SSL_CTX_set_generate_session_id, SSL_set_generate_session_id, SSL_has_matching_session_id \- manipulate generation of SSL session IDs (server only)
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 1
137 \& #include <openssl/ssl.h>
138 \&
139 \& typedef int (*GEN_SESSION_CB)(const SSL *ssl, unsigned char *id,
140 \&                               unsigned int *id_len);
141 \&
142 \& int SSL_CTX_set_generate_session_id(SSL_CTX *ctx, GEN_SESSION_CB cb);
143 \& int SSL_set_generate_session_id(SSL *ssl, GEN_SESSION_CB, cb);
144 \& int SSL_has_matching_session_id(const SSL *ssl, const unsigned char *id,
145 \&                                 unsigned int id_len);
146 .Ve
147 .SH "DESCRIPTION"
148 .IX Header "DESCRIPTION"
149 \&\fISSL_CTX_set_generate_session_id()\fR sets the callback function for generating
150 new session ids for \s-1SSL/TLS\s0 sessions for \fBctx\fR to be \fBcb\fR.
151 .PP
152 \&\fISSL_set_generate_session_id()\fR sets the callback function for generating
153 new session ids for \s-1SSL/TLS\s0 sessions for \fBssl\fR to be \fBcb\fR.
154 .PP
155 \&\fISSL_has_matching_session_id()\fR checks, whether a session with id \fBid\fR
156 (of length \fBid_len\fR) is already contained in the internal session cache
157 of the parent context of \fBssl\fR.
158 .SH "NOTES"
159 .IX Header "NOTES"
160 When a new session is established between client and server, the server
161 generates a session id. The session id is an arbitrary sequence of bytes.
162 The length of the session id is 16 bytes for SSLv2 sessions and between
163 1 and 32 bytes for SSLv3/TLSv1. The session id is not security critical
164 but must be unique for the server. Additionally, the session id is
165 transmitted in the clear when reusing the session so it must not contain
166 sensitive information.
167 .PP
168 Without a callback being set, an OpenSSL server will generate a unique
169 session id from pseudo random numbers of the maximum possible length.
170 Using the callback function, the session id can be changed to contain
171 additional information like e.g. a host id in order to improve load balancing
172 or external caching techniques.
173 .PP
174 The callback function receives a pointer to the memory location to put
175 \&\fBid\fR into and a pointer to the maximum allowed length \fBid_len\fR. The
176 buffer at location \fBid\fR is only guaranteed to have the size \fBid_len\fR.
177 The callback is only allowed to generate a shorter id and reduce \fBid_len\fR;
178 the callback \fBmust never\fR increase \fBid_len\fR or write to the location
179 \&\fBid\fR exceeding the given limit.
180 .PP
181 If a SSLv2 session id is generated and \fBid_len\fR is reduced, it will be
182 restored after the callback has finished and the session id will be padded
183 with 0x00. It is not recommended to change the \fBid_len\fR for SSLv2 sessions.
184 The callback can use the \fISSL_get_version\fR\|(3) function
185 to check, whether the session is of type SSLv2.
186 .PP
187 The location \fBid\fR is filled with 0x00 before the callback is called, so the
188 callback may only fill part of the possible length and leave \fBid_len\fR
189 untouched while maintaining reproducibility.
190 .PP
191 Since the sessions must be distinguished, session ids must be unique.
192 Without the callback a random number is used, so that the probability
193 of generating the same session id is extremely small (2^128 possible ids
194 for an SSLv2 session, 2^256 for SSLv3/TLSv1). In order to assure the
195 uniqueness of the generated session id, the callback must call
196 \&\fISSL_has_matching_session_id()\fR and generate another id if a conflict occurs.
197 If an id conflict is not resolved, the handshake will fail.
198 If the application codes e.g. a unique host id, a unique process number, and
199 a unique sequence number into the session id, uniqueness could easily be
200 achieved without randomness added (it should however be taken care that
201 no confidential information is leaked this way). If the application can not
202 guarantee uniqueness, it is recommended to use the maximum \fBid_len\fR and
203 fill in the bytes not used to code special information with random data
204 to avoid collisions.
205 .PP
206 \&\fISSL_has_matching_session_id()\fR will only query the internal session cache,
207 not the external one. Since the session id is generated before the
208 handshake is completed, it is not immediately added to the cache. If
209 another thread is using the same internal session cache, a race condition
210 can occur in that another thread generates the same session id.
211 Collisions can also occur when using an external session cache, since
212 the external cache is not tested with \fISSL_has_matching_session_id()\fR
213 and the same race condition applies.
214 .PP
215 When calling \fISSL_has_matching_session_id()\fR for an SSLv2 session with
216 reduced \fBid_len\fR, the match operation will be performed using the
217 fixed length required and with a 0x00 padded id.
218 .PP
219 The callback must return 0 if it cannot generate a session id for whatever
220 reason and return 1 on success.
221 .SH "EXAMPLES"
222 .IX Header "EXAMPLES"
223 The callback function listed will generate a session id with the
224 server id given, and will fill the rest with pseudo random bytes:
225 .PP
226 .Vb 1
227 \& const char session_id_prefix = "www\-18";
228 \&
229 \& #define MAX_SESSION_ID_ATTEMPTS 10
230 \& static int generate_session_id(const SSL *ssl, unsigned char *id,
231 \&                              unsigned int *id_len)
232 \&      {
233 \&      unsigned int count = 0;
234 \&      const char *version;
235 \&
236 \&      version = SSL_get_version(ssl);
237 \&      if (!strcmp(version, "SSLv2"))
238 \&          /* we must not change id_len */;
239 \&
240 \&      do      {
241 \&              RAND_pseudo_bytes(id, *id_len);
242 \&              /* Prefix the session_id with the required prefix. NB: If our
243 \&               * prefix is too long, clip it \- but there will be worse effects
244 \&               * anyway, eg. the server could only possibly create 1 session
245 \&               * ID (ie. the prefix!) so all future session negotiations will
246 \&               * fail due to conflicts. */
247 \&              memcpy(id, session_id_prefix,
248 \&                      (strlen(session_id_prefix) < *id_len) ?
249 \&                      strlen(session_id_prefix) : *id_len);
250 \&              }
251 \&      while(SSL_has_matching_session_id(ssl, id, *id_len) &&
252 \&              (++count < MAX_SESSION_ID_ATTEMPTS));
253 \&      if(count >= MAX_SESSION_ID_ATTEMPTS)
254 \&              return 0;
255 \&      return 1;
256 \&      }
257 .Ve
258 .SH "RETURN VALUES"
259 .IX Header "RETURN VALUES"
260 \&\fISSL_CTX_set_generate_session_id()\fR and \fISSL_set_generate_session_id()\fR
261 always return 1.
262 .PP
263 \&\fISSL_has_matching_session_id()\fR returns 1 if another session with the
264 same id is already in the cache.
265 .SH "SEE ALSO"
266 .IX Header "SEE ALSO"
267 \&\fIssl\fR\|(3), \fISSL_get_version\fR\|(3)
268 .SH "HISTORY"
269 .IX Header "HISTORY"
270 \&\fISSL_CTX_set_generate_session_id()\fR, \fISSL_set_generate_session_id()\fR
271 and \fISSL_has_matching_session_id()\fR have been introduced in
272 OpenSSL 0.9.7.