secure/lib/libssl/man/SSL_CTX_set_info_callback.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:47:41 2003
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` ""
  50 .    ds C' ""
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 ..
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "SSL_CTX_set_info_callback 3"
 141 .TH SSL_CTX_set_info_callback 3 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 SSL_CTX_set_info_callback, SSL_CTX_get_info_callback, SSL_set_info_callback, SSL_get_info_callback \- handle information callback for \s-1SSL\s0 connections
 145 .SH "SYNOPSIS"
 146 .IX Header "SYNOPSIS"
 147 .Vb 1
 148 \& #include <openssl/ssl.h>
 149 .Ve
 150 .Vb 2
 151 \& void SSL_CTX_set_info_callback(SSL_CTX *ctx, void (*callback)());
 152 \& void (*SSL_CTX_get_info_callback(SSL_CTX *ctx))();
 153 .Ve
 154 .Vb 2
 155 \& void SSL_set_info_callback(SSL *ssl, void (*callback)());
 156 \& void (*SSL_get_info_callback(SSL *ssl))();
 157 .Ve
 158 .SH "DESCRIPTION"
 159 .IX Header "DESCRIPTION"
 160 \&\fISSL_CTX_set_info_callback()\fR sets the \fBcallback\fR function, that can be used to
 161 obtain state information for \s-1SSL\s0 objects created from \fBctx\fR during connection
 162 setup and use. The setting for \fBctx\fR is overridden from the setting for
 163 a specific \s-1SSL\s0 object, if specified.
 164 When \fBcallback\fR is \s-1NULL\s0, not callback function is used.
 165 .PP
 166 \&\fISSL_set_info_callback()\fR sets the \fBcallback\fR function, that can be used to
 167 obtain state information for \fBssl\fR during connection setup and use.
 168 When \fBcallback\fR is \s-1NULL\s0, the callback setting currently valid for
 169 \&\fBctx\fR is used.
 170 .PP
 171 \&\fISSL_CTX_get_info_callback()\fR returns a pointer to the currently set information
 172 callback function for \fBctx\fR.
 173 .PP
 174 \&\fISSL_get_info_callback()\fR returns a pointer to the currently set information
 175 callback function for \fBssl\fR.
 176 .SH "NOTES"
 177 .IX Header "NOTES"
 178 When setting up a connection and during use, it is possible to obtain state
 179 information from the \s-1SSL/TLS\s0 engine. When set, an information callback function
 180 is called whenever the state changes, an alert appears, or an error occurs.
 181 .PP
 182 The callback function is called as \fBcallback(\s-1SSL\s0 *ssl, int where, int ret)\fR.
 183 The \fBwhere\fR argument specifies information about where (in which context)
 184 the callback function was called. If \fBret\fR is 0, an error condition occurred.
 185 If an alert is handled, \s-1SSL_CB_ALERT\s0 is set and \fBret\fR specifies the alert
 186 information.
 187 .PP
 188 \&\fBwhere\fR is a bitmask made up of the following bits:
 189 .Ip "\s-1SSL_CB_LOOP\s0" 4
 190 .IX Item "SSL_CB_LOOP"
 191 Callback has been called to indicate state change inside a loop.
 192 .Ip "\s-1SSL_CB_EXIT\s0" 4
 193 .IX Item "SSL_CB_EXIT"
 194 Callback has been called to indicate error exit of a handshake function.
 195 (May be soft error with retry option for non-blocking setups.)
 196 .Ip "\s-1SSL_CB_READ\s0" 4
 197 .IX Item "SSL_CB_READ"
 198 Callback has been called during read operation.
 199 .Ip "\s-1SSL_CB_WRITE\s0" 4
 200 .IX Item "SSL_CB_WRITE"
 201 Callback has been called during write operation.
 202 .Ip "\s-1SSL_CB_ALERT\s0" 4
 203 .IX Item "SSL_CB_ALERT"
 204 Callback has been called due to an alert being sent or received.
 205 .Ip "\s-1SSL_CB_READ_ALERT\s0               (SSL_CB_ALERT|SSL_CB_READ)" 4
 206 .IX Item "SSL_CB_READ_ALERT               (SSL_CB_ALERT|SSL_CB_READ)"
 207 .PD 0
 208 .Ip "\s-1SSL_CB_WRITE_ALERT\s0              (SSL_CB_ALERT|SSL_CB_WRITE)" 4
 209 .IX Item "SSL_CB_WRITE_ALERT              (SSL_CB_ALERT|SSL_CB_WRITE)"
 210 .Ip "\s-1SSL_CB_ACCEPT_LOOP\s0              (SSL_ST_ACCEPT|SSL_CB_LOOP)" 4
 211 .IX Item "SSL_CB_ACCEPT_LOOP              (SSL_ST_ACCEPT|SSL_CB_LOOP)"
 212 .Ip "\s-1SSL_CB_ACCEPT_EXIT\s0              (SSL_ST_ACCEPT|SSL_CB_EXIT)" 4
 213 .IX Item "SSL_CB_ACCEPT_EXIT              (SSL_ST_ACCEPT|SSL_CB_EXIT)"
 214 .Ip "\s-1SSL_CB_CONNECT_LOOP\s0             (SSL_ST_CONNECT|SSL_CB_LOOP)" 4
 215 .IX Item "SSL_CB_CONNECT_LOOP             (SSL_ST_CONNECT|SSL_CB_LOOP)"
 216 .Ip "\s-1SSL_CB_CONNECT_EXIT\s0             (SSL_ST_CONNECT|SSL_CB_EXIT)" 4
 217 .IX Item "SSL_CB_CONNECT_EXIT             (SSL_ST_CONNECT|SSL_CB_EXIT)"
 218 .Ip "\s-1SSL_CB_HANDSHAKE_START\s0" 4
 219 .IX Item "SSL_CB_HANDSHAKE_START"
 220 .PD
 221 Callback has been called because a new handshake is started.
 222 .Ip "\s-1SSL_CB_HANDSHAKE_DONE\s0           0x20" 4
 223 .IX Item "SSL_CB_HANDSHAKE_DONE           0x20"
 224 Callback has been called because a handshake is finished.
 225 .PP
 226 The current state information can be obtained using the
 227 SSL_state_string(3) family of functions.
 228 .PP
 229 The \fBret\fR information can be evaluated using the
 230 SSL_alert_type_string(3) family of functions.
 231 .SH "RETURN VALUES"
 232 .IX Header "RETURN VALUES"
 233 \&\fISSL_set_info_callback()\fR does not provide diagnostic information.
 234 .PP
 235 \&\fISSL_get_info_callback()\fR returns the current setting.
 236 .SH "EXAMPLES"
 237 .IX Header "EXAMPLES"
 238 The following example callback function prints state strings, information
 239 about alerts being handled and error messages to the \fBbio_err\fR \s-1BIO\s0.
 240 .PP
 241 .Vb 4
 242 \& void apps_ssl_info_callback(SSL *s, int where, int ret)
 243 \&        {
 244 \&        const char *str;
 245 \&        int w;
 246 .Ve
 247 .Vb 1
 248 \&        w=where& ~SSL_ST_MASK;
 249 .Ve
 250 .Vb 3
 251 \&        if (w & SSL_ST_CONNECT) str="SSL_connect";
 252 \&        else if (w & SSL_ST_ACCEPT) str="SSL_accept";
 253 \&        else str="undefined";
 254 .Ve
 255 .Vb 24
 256 \&        if (where & SSL_CB_LOOP)
 257 \&                {
 258 \&                BIO_printf(bio_err,"%s:%s\en",str,SSL_state_string_long(s));
 259 \&                }
 260 \&        else if (where & SSL_CB_ALERT)
 261 \&                {
 262 \&                str=(where & SSL_CB_READ)?"read":"write";
 263 \&                BIO_printf(bio_err,"SSL3 alert %s:%s:%s\en",
 264 \&                        str,
 265 \&                        SSL_alert_type_string_long(ret),
 266 \&                        SSL_alert_desc_string_long(ret));
 267 \&                }
 268 \&        else if (where & SSL_CB_EXIT)
 269 \&                {
 270 \&                if (ret == 0)
 271 \&                        BIO_printf(bio_err,"%s:failed in %s\en",
 272 \&                                str,SSL_state_string_long(s));
 273 \&                else if (ret < 0)
 274 \&                        {
 275 \&                        BIO_printf(bio_err,"%s:error in %s\en",
 276 \&                                str,SSL_state_string_long(s));
 277 \&                        }
 278 \&                }
 279 \&        }
 280 .Ve
 281 .SH "SEE ALSO"
 282 .IX Header "SEE ALSO"
 283 ssl(3), SSL_state_string(3),
 284 SSL_alert_type_string(3)