Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_info_callback.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_set_info_callback 3"
e257b235
PA
135.TH SSL_CTX_set_info_callback 3 "2009-01-11" "0.9.8j" "OpenSSL"
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 140.SH "NAME"
a7d27d5a 141SSL_CTX_set_info_callback, SSL_CTX_get_info_callback, SSL_set_info_callback, SSL_get_info_callback \- handle information callback for SSL connections
984263bc 142.SH "SYNOPSIS"
e056f0e0 143.IX Header "SYNOPSIS"
984263bc
MD
144.Vb 1
145\& #include <openssl/ssl.h>
e257b235 146\&
984263bc 147\& void SSL_CTX_set_info_callback(SSL_CTX *ctx, void (*callback)());
a561f9ff 148\& void (*SSL_CTX_get_info_callback(const SSL_CTX *ctx))();
e257b235 149\&
984263bc 150\& void SSL_set_info_callback(SSL *ssl, void (*callback)());
a561f9ff 151\& void (*SSL_get_info_callback(const SSL *ssl))();
984263bc
MD
152.Ve
153.SH "DESCRIPTION"
e056f0e0
JR
154.IX Header "DESCRIPTION"
155\&\fISSL_CTX_set_info_callback()\fR sets the \fBcallback\fR function, that can be used to
156obtain state information for \s-1SSL\s0 objects created from \fBctx\fR during connection
984263bc 157setup and use. The setting for \fBctx\fR is overridden from the setting for
e056f0e0
JR
158a specific \s-1SSL\s0 object, if specified.
159When \fBcallback\fR is \s-1NULL\s0, not callback function is used.
984263bc 160.PP
e056f0e0 161\&\fISSL_set_info_callback()\fR sets the \fBcallback\fR function, that can be used to
984263bc 162obtain state information for \fBssl\fR during connection setup and use.
e056f0e0
JR
163When \fBcallback\fR is \s-1NULL\s0, the callback setting currently valid for
164\&\fBctx\fR is used.
984263bc 165.PP
e056f0e0 166\&\fISSL_CTX_get_info_callback()\fR returns a pointer to the currently set information
984263bc
MD
167callback function for \fBctx\fR.
168.PP
e056f0e0 169\&\fISSL_get_info_callback()\fR returns a pointer to the currently set information
984263bc
MD
170callback function for \fBssl\fR.
171.SH "NOTES"
e056f0e0 172.IX Header "NOTES"
984263bc 173When setting up a connection and during use, it is possible to obtain state
e056f0e0 174information from the \s-1SSL/TLS\s0 engine. When set, an information callback function
984263bc
MD
175is called whenever the state changes, an alert appears, or an error occurs.
176.PP
e056f0e0 177The callback function is called as \fBcallback(\s-1SSL\s0 *ssl, int where, int ret)\fR.
984263bc
MD
178The \fBwhere\fR argument specifies information about where (in which context)
179the callback function was called. If \fBret\fR is 0, an error condition occurred.
e056f0e0 180If an alert is handled, \s-1SSL_CB_ALERT\s0 is set and \fBret\fR specifies the alert
984263bc
MD
181information.
182.PP
e056f0e0
JR
183\&\fBwhere\fR is a bitmask made up of the following bits:
184.IP "\s-1SSL_CB_LOOP\s0" 4
185.IX Item "SSL_CB_LOOP"
984263bc 186Callback has been called to indicate state change inside a loop.
e056f0e0
JR
187.IP "\s-1SSL_CB_EXIT\s0" 4
188.IX Item "SSL_CB_EXIT"
984263bc
MD
189Callback has been called to indicate error exit of a handshake function.
190(May be soft error with retry option for non-blocking setups.)
e056f0e0
JR
191.IP "\s-1SSL_CB_READ\s0" 4
192.IX Item "SSL_CB_READ"
984263bc 193Callback has been called during read operation.
e056f0e0
JR
194.IP "\s-1SSL_CB_WRITE\s0" 4
195.IX Item "SSL_CB_WRITE"
984263bc 196Callback has been called during write operation.
e056f0e0
JR
197.IP "\s-1SSL_CB_ALERT\s0" 4
198.IX Item "SSL_CB_ALERT"
984263bc 199Callback has been called due to an alert being sent or received.
e056f0e0
JR
200.IP "\s-1SSL_CB_READ_ALERT\s0 (SSL_CB_ALERT|SSL_CB_READ)" 4
201.IX Item "SSL_CB_READ_ALERT (SSL_CB_ALERT|SSL_CB_READ)"
202.PD 0
203.IP "\s-1SSL_CB_WRITE_ALERT\s0 (SSL_CB_ALERT|SSL_CB_WRITE)" 4
204.IX Item "SSL_CB_WRITE_ALERT (SSL_CB_ALERT|SSL_CB_WRITE)"
205.IP "\s-1SSL_CB_ACCEPT_LOOP\s0 (SSL_ST_ACCEPT|SSL_CB_LOOP)" 4
206.IX Item "SSL_CB_ACCEPT_LOOP (SSL_ST_ACCEPT|SSL_CB_LOOP)"
207.IP "\s-1SSL_CB_ACCEPT_EXIT\s0 (SSL_ST_ACCEPT|SSL_CB_EXIT)" 4
208.IX Item "SSL_CB_ACCEPT_EXIT (SSL_ST_ACCEPT|SSL_CB_EXIT)"
209.IP "\s-1SSL_CB_CONNECT_LOOP\s0 (SSL_ST_CONNECT|SSL_CB_LOOP)" 4
210.IX Item "SSL_CB_CONNECT_LOOP (SSL_ST_CONNECT|SSL_CB_LOOP)"
211.IP "\s-1SSL_CB_CONNECT_EXIT\s0 (SSL_ST_CONNECT|SSL_CB_EXIT)" 4
212.IX Item "SSL_CB_CONNECT_EXIT (SSL_ST_CONNECT|SSL_CB_EXIT)"
213.IP "\s-1SSL_CB_HANDSHAKE_START\s0" 4
214.IX Item "SSL_CB_HANDSHAKE_START"
215.PD
984263bc 216Callback has been called because a new handshake is started.
e056f0e0
JR
217.IP "\s-1SSL_CB_HANDSHAKE_DONE\s0 0x20" 4
218.IX Item "SSL_CB_HANDSHAKE_DONE 0x20"
984263bc
MD
219Callback has been called because a handshake is finished.
220.PP
221The current state information can be obtained using the
e056f0e0 222\&\fISSL_state_string\fR\|(3) family of functions.
984263bc
MD
223.PP
224The \fBret\fR information can be evaluated using the
e056f0e0 225\&\fISSL_alert_type_string\fR\|(3) family of functions.
984263bc 226.SH "RETURN VALUES"
e056f0e0
JR
227.IX Header "RETURN VALUES"
228\&\fISSL_set_info_callback()\fR does not provide diagnostic information.
984263bc 229.PP
e056f0e0 230\&\fISSL_get_info_callback()\fR returns the current setting.
984263bc 231.SH "EXAMPLES"
e056f0e0 232.IX Header "EXAMPLES"
984263bc 233The following example callback function prints state strings, information
e056f0e0 234about alerts being handled and error messages to the \fBbio_err\fR \s-1BIO\s0.
984263bc
MD
235.PP
236.Vb 4
237\& void apps_ssl_info_callback(SSL *s, int where, int ret)
238\& {
239\& const char *str;
240\& int w;
e257b235 241\&
984263bc 242\& w=where& ~SSL_ST_MASK;
e257b235 243\&
984263bc
MD
244\& if (w & SSL_ST_CONNECT) str="SSL_connect";
245\& else if (w & SSL_ST_ACCEPT) str="SSL_accept";
246\& else str="undefined";
e257b235 247\&
984263bc
MD
248\& if (where & SSL_CB_LOOP)
249\& {
250\& BIO_printf(bio_err,"%s:%s\en",str,SSL_state_string_long(s));
251\& }
252\& else if (where & SSL_CB_ALERT)
253\& {
254\& str=(where & SSL_CB_READ)?"read":"write";
255\& BIO_printf(bio_err,"SSL3 alert %s:%s:%s\en",
256\& str,
257\& SSL_alert_type_string_long(ret),
258\& SSL_alert_desc_string_long(ret));
259\& }
260\& else if (where & SSL_CB_EXIT)
261\& {
262\& if (ret == 0)
263\& BIO_printf(bio_err,"%s:failed in %s\en",
264\& str,SSL_state_string_long(s));
265\& else if (ret < 0)
266\& {
267\& BIO_printf(bio_err,"%s:error in %s\en",
268\& str,SSL_state_string_long(s));
269\& }
270\& }
271\& }
272.Ve
273.SH "SEE ALSO"
a7d27d5a 274.IX Header "SEE ALSO"
e056f0e0
JR
275\&\fIssl\fR\|(3), \fISSL_state_string\fR\|(3),
276\&\fISSL_alert_type_string\fR\|(3)