Merge branch 'master' of git://chlamydia.fs.ei.tum.de/dragonfly
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_sess_set_get_cb.3
CommitLineData
e257b235 1.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
e056f0e0
JR
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
984263bc
MD
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
e056f0e0 13.de Sp \" Vertical space (when we can't use .PP)
984263bc
MD
14.if t .sp .5v
15.if n .sp
16..
e056f0e0 17.de Vb \" Begin verbatim text
984263bc
MD
18.ft CW
19.nf
20.ne \\$1
21..
e056f0e0 22.de Ve \" End verbatim text
984263bc 23.ft R
984263bc
MD
24.fi
25..
e056f0e0
JR
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
e257b235
PA
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-
e056f0e0 33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
984263bc 34.ie n \{\
e056f0e0
JR
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' ""
984263bc
MD
43'br\}
44.el\{\
e056f0e0
JR
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
984263bc 49'br\}
e056f0e0 50.\"
e257b235
PA
51.\" Escape single quotes in literal strings from groff's Unicode transform.
52.ie \n(.g .ds Aq \(aq
53.el .ds Aq '
54.\"
e056f0e0
JR
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.
e257b235 59.ie \nF \{\
e056f0e0
JR
60. de IX
61. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 62..
e056f0e0
JR
63. nr % 0
64. rr F
984263bc 65.\}
e257b235
PA
66.el \{\
67. de IX
68..
69.\}
aac4ff6f 70.\"
e056f0e0
JR
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
984263bc 74.if n \{\
e056f0e0
JR
75. ds #H 0
76. ds #V .8m
77. ds #F .3m
78. ds #[ \f1
79. ds #] \fP
984263bc
MD
80.\}
81.if t \{\
e056f0e0
JR
82. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83. ds #V .6m
84. ds #F 0
85. ds #[ \&
86. ds #] \&
984263bc 87.\}
e056f0e0 88. \" simple accents for nroff and troff
984263bc 89.if n \{\
e056f0e0
JR
90. ds ' \&
91. ds ` \&
92. ds ^ \&
93. ds , \&
94. ds ~ ~
95. ds /
984263bc
MD
96.\}
97.if t \{\
e056f0e0
JR
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'
984263bc 104.\}
e056f0e0 105. \" troff and (daisy-wheel) nroff accents
984263bc
MD
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
e056f0e0 115. \" corrections for vroff
984263bc
MD
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'
e056f0e0 118. \" for low resolution devices (crt and lpr)
984263bc
MD
119.if \n(.H>23 .if \n(.V>19 \
120\{\
e056f0e0
JR
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
984263bc
MD
130.\}
131.rm #[ #] #H #V #F C
e056f0e0
JR
132.\" ========================================================================
133.\"
134.IX Title "SSL_CTX_sess_set_get_cb 3"
9bb34a8c 135.TH SSL_CTX_sess_set_get_cb 3 "2009-11-06" "0.9.8l" "OpenSSL"
e257b235
PA
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
984263bc
MD
140.SH "NAME"
141SSL_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
142.SH "SYNOPSIS"
e056f0e0 143.IX Header "SYNOPSIS"
984263bc
MD
144.Vb 1
145\& #include <openssl/ssl.h>
e257b235 146\&
984263bc
MD
147\& void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
148\& int (*new_session_cb)(SSL *, SSL_SESSION *));
149\& void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
150\& void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *));
151\& void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
152\& SSL_SESSION (*get_session_cb)(SSL *, unsigned char *, int, int *));
e257b235 153\&
984263bc
MD
154\& int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(struct ssl_st *ssl, SSL_SESSION *sess);
155\& void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(struct ssl_ctx_st *ctx, SSL_SESSION *sess);
156\& SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(struct ssl_st *ssl, unsigned char *data, int len, int *copy);
e257b235 157\&
984263bc
MD
158\& int (*new_session_cb)(struct ssl_st *ssl, SSL_SESSION *sess);
159\& void (*remove_session_cb)(struct ssl_ctx_st *ctx, SSL_SESSION *sess);
160\& SSL_SESSION *(*get_session_cb)(struct ssl_st *ssl, unsigned char *data,
161\& int len, int *copy);
162.Ve
163.SH "DESCRIPTION"
e056f0e0
JR
164.IX Header "DESCRIPTION"
165\&\fISSL_CTX_sess_set_new_cb()\fR sets the callback function, which is automatically
984263bc
MD
166called whenever a new session was negotiated.
167.PP
e056f0e0
JR
168\&\fISSL_CTX_sess_set_remove_cb()\fR sets the callback function, which is
169automatically called whenever a session is removed by the \s-1SSL\s0 engine,
984263bc
MD
170because it is considered faulty or the session has become obsolete because
171of exceeding the timeout value.
172.PP
e056f0e0
JR
173\&\fISSL_CTX_sess_set_get_cb()\fR sets the callback function which is called,
174whenever a \s-1SSL/TLS\s0 client proposed to resume a session but the session
984263bc 175could not be found in the internal session cache (see
e056f0e0
JR
176\&\fISSL_CTX_set_session_cache_mode\fR\|(3)).
177(\s-1SSL/TLS\s0 server only.)
984263bc 178.PP
e056f0e0
JR
179\&\fISSL_CTX_sess_get_new_cb()\fR, \fISSL_CTX_sess_get_remove_cb()\fR, and
180\&\fISSL_CTX_sess_get_get_cb()\fR allow to retrieve the function pointers of the
984263bc 181provided callback functions. If a callback function has not been set,
e056f0e0 182the \s-1NULL\s0 pointer is returned.
984263bc 183.SH "NOTES"
e056f0e0 184.IX Header "NOTES"
984263bc
MD
185In order to allow external session caching, synchronization with the internal
186session cache is realized via callback functions. Inside these callback
187functions, session can be saved to disk or put into a database using the
e056f0e0 188\&\fId2i_SSL_SESSION\fR\|(3) interface.
984263bc
MD
189.PP
190The \fInew_session_cb()\fR is called, whenever a new session has been negotiated
191and session caching is enabled (see
e056f0e0 192\&\fISSL_CTX_set_session_cache_mode\fR\|(3)).
984263bc 193The \fInew_session_cb()\fR is passed the \fBssl\fR connection and the ssl session
e056f0e0 194\&\fBsess\fR. If the callback returns \fB0\fR, the session will be immediately
984263bc
MD
195removed again.
196.PP
e056f0e0 197The \fIremove_session_cb()\fR is called, whenever the \s-1SSL\s0 engine removes a session
a7d27d5a
JR
198from the internal cache. This happens when the session is removed because
199it is expired or when a connection was not shutdown cleanly. It also happens
200for all sessions in the internal session cache when
e056f0e0 201\&\fISSL_CTX_free\fR\|(3) is called. The \fIremove_session_cb()\fR is passed
a7d27d5a 202the \fBctx\fR and the ssl session \fBsess\fR. It does not provide any feedback.
984263bc 203.PP
e056f0e0 204The \fIget_session_cb()\fR is only called on \s-1SSL/TLS\s0 servers with the session id
984263bc
MD
205proposed by the client. The \fIget_session_cb()\fR is always called, also when
206session caching was disabled. The \fIget_session_cb()\fR is passed the
e056f0e0
JR
207\&\fBssl\fR connection, the session id of length \fBlength\fR at the memory location
208\&\fBdata\fR. With the parameter \fBcopy\fR the callback can require the
209\&\s-1SSL\s0 engine to increment the reference count of the \s-1SSL_SESSION\s0 object,
984263bc
MD
210Normally the reference count is not incremented and therefore the
211session must not be explicitly freed with
e056f0e0 212\&\fISSL_SESSION_free\fR\|(3).
984263bc 213.SH "SEE ALSO"
a7d27d5a 214.IX Header "SEE ALSO"
e056f0e0
JR
215\&\fIssl\fR\|(3), \fId2i_SSL_SESSION\fR\|(3),
216\&\fISSL_CTX_set_session_cache_mode\fR\|(3),
217\&\fISSL_CTX_flush_sessions\fR\|(3),
218\&\fISSL_SESSION_free\fR\|(3),
219\&\fISSL_CTX_free\fR\|(3)