Update build for OpenSSL-1.0.0a.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_sess_set_get_cb.3
1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
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_sess_set_get_cb 3"
127 .TH SSL_CTX_sess_set_get_cb 3 "2010-06-01" "1.0.0a" "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_sess_set_new_cb, SSL_CTX_sess_set_remove_cb, SSL_CTX_sess_set_get_cb, SSL_CTX_sess_get_new_cb, SSL_CTX_sess_get_remove_cb, SSL_CTX_sess_get_get_cb \- provide callback functions for server side external session caching
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 .Vb 1
137 \& #include <openssl/ssl.h>
138 \&
139 \& void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
140 \&                              int (*new_session_cb)(SSL *, SSL_SESSION *));
141 \& void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
142 \&           void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *));
143 \& void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
144 \&           SSL_SESSION (*get_session_cb)(SSL *, unsigned char *, int, int *));
145 \&
146 \& int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(struct ssl_st *ssl, SSL_SESSION *sess);
147 \& void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(struct ssl_ctx_st *ctx, SSL_SESSION *sess);
148 \& SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(struct ssl_st *ssl, unsigned char *data, int len, int *copy);
149 \&
150 \& int (*new_session_cb)(struct ssl_st *ssl, SSL_SESSION *sess);
151 \& void (*remove_session_cb)(struct ssl_ctx_st *ctx, SSL_SESSION *sess);
152 \& SSL_SESSION *(*get_session_cb)(struct ssl_st *ssl, unsigned char *data,
153 \&               int len, int *copy);
154 .Ve
155 .SH "DESCRIPTION"
156 .IX Header "DESCRIPTION"
157 \&\fISSL_CTX_sess_set_new_cb()\fR sets the callback function, which is automatically
158 called whenever a new session was negotiated.
159 .PP
160 \&\fISSL_CTX_sess_set_remove_cb()\fR sets the callback function, which is
161 automatically called whenever a session is removed by the \s-1SSL\s0 engine,
162 because it is considered faulty or the session has become obsolete because
163 of exceeding the timeout value.
164 .PP
165 \&\fISSL_CTX_sess_set_get_cb()\fR sets the callback function which is called,
166 whenever a \s-1SSL/TLS\s0 client proposed to resume a session but the session
167 could not be found in the internal session cache (see
168 \&\fISSL_CTX_set_session_cache_mode\fR\|(3)).
169 (\s-1SSL/TLS\s0 server only.)
170 .PP
171 \&\fISSL_CTX_sess_get_new_cb()\fR, \fISSL_CTX_sess_get_remove_cb()\fR, and
172 \&\fISSL_CTX_sess_get_get_cb()\fR allow to retrieve the function pointers of the
173 provided callback functions. If a callback function has not been set,
174 the \s-1NULL\s0 pointer is returned.
175 .SH "NOTES"
176 .IX Header "NOTES"
177 In order to allow external session caching, synchronization with the internal
178 session cache is realized via callback functions. Inside these callback
179 functions, session can be saved to disk or put into a database using the
180 \&\fId2i_SSL_SESSION\fR\|(3) interface.
181 .PP
182 The \fInew_session_cb()\fR is called, whenever a new session has been negotiated
183 and session caching is enabled (see
184 \&\fISSL_CTX_set_session_cache_mode\fR\|(3)).
185 The \fInew_session_cb()\fR is passed the \fBssl\fR connection and the ssl session
186 \&\fBsess\fR. If the callback returns \fB0\fR, the session will be immediately
187 removed again.
188 .PP
189 The \fIremove_session_cb()\fR is called, whenever the \s-1SSL\s0 engine removes a session
190 from the internal cache. This happens when the session is removed because
191 it is expired or when a connection was not shutdown cleanly. It also happens
192 for all sessions in the internal session cache when
193 \&\fISSL_CTX_free\fR\|(3) is called. The \fIremove_session_cb()\fR is passed
194 the \fBctx\fR and the ssl session \fBsess\fR. It does not provide any feedback.
195 .PP
196 The \fIget_session_cb()\fR is only called on \s-1SSL/TLS\s0 servers with the session id
197 proposed by the client. The \fIget_session_cb()\fR is always called, also when
198 session caching was disabled. The \fIget_session_cb()\fR is passed the
199 \&\fBssl\fR connection, the session id of length \fBlength\fR at the memory location
200 \&\fBdata\fR. With the parameter \fBcopy\fR the callback can require the
201 \&\s-1SSL\s0 engine to increment the reference count of the \s-1SSL_SESSION\s0 object,
202 Normally the reference count is not incremented and therefore the
203 session must not be explicitly freed with
204 \&\fISSL_SESSION_free\fR\|(3).
205 .SH "SEE ALSO"
206 .IX Header "SEE ALSO"
207 \&\fIssl\fR\|(3), \fId2i_SSL_SESSION\fR\|(3),
208 \&\fISSL_CTX_set_session_cache_mode\fR\|(3),
209 \&\fISSL_CTX_flush_sessions\fR\|(3),
210 \&\fISSL_SESSION_free\fR\|(3),
211 \&\fISSL_CTX_free\fR\|(3)