secure/lib/libssl/man/SSL_CTX_set_info_callback.3

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