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