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