Update build for OpenSSL-0.9.8j upgrade.
[dragonfly.git] / secure / lib / libssl / man / SSL_CTX_set_info_callback.3
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
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.  \*(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-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
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' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
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.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
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
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
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'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
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
115 .    \" corrections for vroff
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'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
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
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "SSL_CTX_set_info_callback 3"
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
140 .SH "NAME"
141 SSL_CTX_set_info_callback, SSL_CTX_get_info_callback, SSL_set_info_callback, SSL_get_info_callback \- handle information callback for SSL connections
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 .Vb 1
145 \& #include <openssl/ssl.h>
146 \&
147 \& void SSL_CTX_set_info_callback(SSL_CTX *ctx, void (*callback)());
148 \& void (*SSL_CTX_get_info_callback(const SSL_CTX *ctx))();
149 \&
150 \& void SSL_set_info_callback(SSL *ssl, void (*callback)());
151 \& void (*SSL_get_info_callback(const SSL *ssl))();
152 .Ve
153 .SH "DESCRIPTION"
154 .IX Header "DESCRIPTION"
155 \&\fISSL_CTX_set_info_callback()\fR sets the \fBcallback\fR function, that can be used to
156 obtain state information for \s-1SSL\s0 objects created from \fBctx\fR during connection
157 setup and use. The setting for \fBctx\fR is overridden from the setting for
158 a specific \s-1SSL\s0 object, if specified.
159 When \fBcallback\fR is \s-1NULL\s0, not callback function is used.
160 .PP
161 \&\fISSL_set_info_callback()\fR sets the \fBcallback\fR function, that can be used to
162 obtain state information for \fBssl\fR during connection setup and use.
163 When \fBcallback\fR is \s-1NULL\s0, the callback setting currently valid for
164 \&\fBctx\fR is used.
165 .PP
166 \&\fISSL_CTX_get_info_callback()\fR returns a pointer to the currently set information
167 callback function for \fBctx\fR.
168 .PP
169 \&\fISSL_get_info_callback()\fR returns a pointer to the currently set information
170 callback function for \fBssl\fR.
171 .SH "NOTES"
172 .IX Header "NOTES"
173 When setting up a connection and during use, it is possible to obtain state
174 information from the \s-1SSL/TLS\s0 engine. When set, an information callback function
175 is called whenever the state changes, an alert appears, or an error occurs.
176 .PP
177 The callback function is called as \fBcallback(\s-1SSL\s0 *ssl, int where, int ret)\fR.
178 The \fBwhere\fR argument specifies information about where (in which context)
179 the callback function was called. If \fBret\fR is 0, an error condition occurred.
180 If an alert is handled, \s-1SSL_CB_ALERT\s0 is set and \fBret\fR specifies the alert
181 information.
182 .PP
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"
186 Callback has been called to indicate state change inside a loop.
187 .IP "\s-1SSL_CB_EXIT\s0" 4
188 .IX Item "SSL_CB_EXIT"
189 Callback has been called to indicate error exit of a handshake function.
190 (May be soft error with retry option for non-blocking setups.)
191 .IP "\s-1SSL_CB_READ\s0" 4
192 .IX Item "SSL_CB_READ"
193 Callback has been called during read operation.
194 .IP "\s-1SSL_CB_WRITE\s0" 4
195 .IX Item "SSL_CB_WRITE"
196 Callback has been called during write operation.
197 .IP "\s-1SSL_CB_ALERT\s0" 4
198 .IX Item "SSL_CB_ALERT"
199 Callback has been called due to an alert being sent or received.
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
216 Callback has been called because a new handshake is started.
217 .IP "\s-1SSL_CB_HANDSHAKE_DONE\s0           0x20" 4
218 .IX Item "SSL_CB_HANDSHAKE_DONE           0x20"
219 Callback has been called because a handshake is finished.
220 .PP
221 The current state information can be obtained using the
222 \&\fISSL_state_string\fR\|(3) family of functions.
223 .PP
224 The \fBret\fR information can be evaluated using the
225 \&\fISSL_alert_type_string\fR\|(3) family of functions.
226 .SH "RETURN VALUES"
227 .IX Header "RETURN VALUES"
228 \&\fISSL_set_info_callback()\fR does not provide diagnostic information.
229 .PP
230 \&\fISSL_get_info_callback()\fR returns the current setting.
231 .SH "EXAMPLES"
232 .IX Header "EXAMPLES"
233 The following example callback function prints state strings, information
234 about alerts being handled and error messages to the \fBbio_err\fR \s-1BIO\s0.
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;
241 \&
242 \&        w=where& ~SSL_ST_MASK;
243 \&
244 \&        if (w & SSL_ST_CONNECT) str="SSL_connect";
245 \&        else if (w & SSL_ST_ACCEPT) str="SSL_accept";
246 \&        else str="undefined";
247 \&
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"
274 .IX Header "SEE ALSO"
275 \&\fIssl\fR\|(3), \fISSL_state_string\fR\|(3),
276 \&\fISSL_alert_type_string\fR\|(3)