secure/lib/libssl/man/SSL_CTX_set_info_callback.3

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