Regenerate manual pages.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_sess_set_get_cb.3
CommitLineData
e056f0e0
JR
1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
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
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
984263bc 32.tr \(*W-|\(bv\*(Tr
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
JR
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
984263bc 58..
e056f0e0
JR
59. nr % 0
60. rr F
984263bc 61.\}
e056f0e0
JR
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
984263bc 66.if n .na
e056f0e0
JR
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
984263bc 71.if n \{\
e056f0e0
JR
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
984263bc
MD
77.\}
78.if t \{\
e056f0e0
JR
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
984263bc 84.\}
e056f0e0 85. \" simple accents for nroff and troff
984263bc 86.if n \{\
e056f0e0
JR
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
984263bc
MD
93.\}
94.if t \{\
e056f0e0
JR
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
984263bc 101.\}
e056f0e0 102. \" troff and (daisy-wheel) nroff accents
984263bc
MD
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
e056f0e0 112. \" corrections for vroff
984263bc
MD
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
e056f0e0 115. \" for low resolution devices (crt and lpr)
984263bc
MD
116.if \n(.H>23 .if \n(.V>19 \
117\{\
e056f0e0
JR
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
984263bc
MD
127.\}
128.rm #[ #] #H #V #F C
e056f0e0
JR
129.\" ========================================================================
130.\"
131.IX Title "SSL_CTX_sess_set_get_cb 3"
132.TH SSL_CTX_sess_set_get_cb 3 "2004-12-22" "0.9.7e" "OpenSSL"
984263bc
MD
133.SH "NAME"
134SSL_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
135.SH "SYNOPSIS"
e056f0e0 136.IX Header "SYNOPSIS"
984263bc
MD
137.Vb 1
138\& #include <openssl/ssl.h>
139.Ve
e056f0e0 140.PP
984263bc
MD
141.Vb 6
142\& void SSL_CTX_sess_set_new_cb(SSL_CTX *ctx,
143\& int (*new_session_cb)(SSL *, SSL_SESSION *));
144\& void SSL_CTX_sess_set_remove_cb(SSL_CTX *ctx,
145\& void (*remove_session_cb)(SSL_CTX *ctx, SSL_SESSION *));
146\& void SSL_CTX_sess_set_get_cb(SSL_CTX *ctx,
147\& SSL_SESSION (*get_session_cb)(SSL *, unsigned char *, int, int *));
148.Ve
e056f0e0 149.PP
984263bc
MD
150.Vb 3
151\& int (*SSL_CTX_sess_get_new_cb(SSL_CTX *ctx))(struct ssl_st *ssl, SSL_SESSION *sess);
152\& void (*SSL_CTX_sess_get_remove_cb(SSL_CTX *ctx))(struct ssl_ctx_st *ctx, SSL_SESSION *sess);
153\& SSL_SESSION *(*SSL_CTX_sess_get_get_cb(SSL_CTX *ctx))(struct ssl_st *ssl, unsigned char *data, int len, int *copy);
154.Ve
e056f0e0 155.PP
984263bc
MD
156.Vb 4
157\& int (*new_session_cb)(struct ssl_st *ssl, SSL_SESSION *sess);
158\& void (*remove_session_cb)(struct ssl_ctx_st *ctx, SSL_SESSION *sess);
159\& SSL_SESSION *(*get_session_cb)(struct ssl_st *ssl, unsigned char *data,
160\& int len, int *copy);
161.Ve
162.SH "DESCRIPTION"
e056f0e0
JR
163.IX Header "DESCRIPTION"
164\&\fISSL_CTX_sess_set_new_cb()\fR sets the callback function, which is automatically
984263bc
MD
165called whenever a new session was negotiated.
166.PP
e056f0e0
JR
167\&\fISSL_CTX_sess_set_remove_cb()\fR sets the callback function, which is
168automatically called whenever a session is removed by the \s-1SSL\s0 engine,
984263bc
MD
169because it is considered faulty or the session has become obsolete because
170of exceeding the timeout value.
171.PP
e056f0e0
JR
172\&\fISSL_CTX_sess_set_get_cb()\fR sets the callback function which is called,
173whenever a \s-1SSL/TLS\s0 client proposed to resume a session but the session
984263bc 174could not be found in the internal session cache (see
e056f0e0
JR
175\&\fISSL_CTX_set_session_cache_mode\fR\|(3)).
176(\s-1SSL/TLS\s0 server only.)
984263bc 177.PP
e056f0e0
JR
178\&\fISSL_CTX_sess_get_new_cb()\fR, \fISSL_CTX_sess_get_remove_cb()\fR, and
179\&\fISSL_CTX_sess_get_get_cb()\fR allow to retrieve the function pointers of the
984263bc 180provided callback functions. If a callback function has not been set,
e056f0e0 181the \s-1NULL\s0 pointer is returned.
984263bc 182.SH "NOTES"
e056f0e0 183.IX Header "NOTES"
984263bc
MD
184In order to allow external session caching, synchronization with the internal
185session cache is realized via callback functions. Inside these callback
186functions, session can be saved to disk or put into a database using the
e056f0e0 187\&\fId2i_SSL_SESSION\fR\|(3) interface.
984263bc
MD
188.PP
189The \fInew_session_cb()\fR is called, whenever a new session has been negotiated
190and session caching is enabled (see
e056f0e0 191\&\fISSL_CTX_set_session_cache_mode\fR\|(3)).
984263bc 192The \fInew_session_cb()\fR is passed the \fBssl\fR connection and the ssl session
e056f0e0 193\&\fBsess\fR. If the callback returns \fB0\fR, the session will be immediately
984263bc
MD
194removed again.
195.PP
e056f0e0 196The \fIremove_session_cb()\fR is called, whenever the \s-1SSL\s0 engine removes a session
a7d27d5a
JR
197from the internal cache. This happens when the session is removed because
198it is expired or when a connection was not shutdown cleanly. It also happens
199for all sessions in the internal session cache when
e056f0e0 200\&\fISSL_CTX_free\fR\|(3) is called. The \fIremove_session_cb()\fR is passed
a7d27d5a 201the \fBctx\fR and the ssl session \fBsess\fR. It does not provide any feedback.
984263bc 202.PP
e056f0e0 203The \fIget_session_cb()\fR is only called on \s-1SSL/TLS\s0 servers with the session id
984263bc
MD
204proposed by the client. The \fIget_session_cb()\fR is always called, also when
205session caching was disabled. The \fIget_session_cb()\fR is passed the
e056f0e0
JR
206\&\fBssl\fR connection, the session id of length \fBlength\fR at the memory location
207\&\fBdata\fR. With the parameter \fBcopy\fR the callback can require the
208\&\s-1SSL\s0 engine to increment the reference count of the \s-1SSL_SESSION\s0 object,
984263bc
MD
209Normally the reference count is not incremented and therefore the
210session must not be explicitly freed with
e056f0e0 211\&\fISSL_SESSION_free\fR\|(3).
984263bc 212.SH "SEE ALSO"
a7d27d5a 213.IX Header "SEE ALSO"
e056f0e0
JR
214\&\fIssl\fR\|(3), \fId2i_SSL_SESSION\fR\|(3),
215\&\fISSL_CTX_set_session_cache_mode\fR\|(3),
216\&\fISSL_CTX_flush_sessions\fR\|(3),
217\&\fISSL_SESSION_free\fR\|(3),
218\&\fISSL_CTX_free\fR\|(3)