secure/lib/libcrypto/man/SSL_CTX_set_msg_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_MSG_CALLBACK 3"
 132 .TH SSL_CTX_SET_MSG_CALLBACK 3 "2018-11-20" "1.1.1a" "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_msg_callback, SSL_CTX_set_msg_callback_arg, SSL_set_msg_callback, SSL_set_msg_callback_arg \&\- install callback for observing protocol messages
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& void SSL_CTX_set_msg_callback(SSL_CTX *ctx,
 145 \&                               void (*cb)(int write_p, int version,
 146 \&                                          int content_type, const void *buf,
 147 \&                                          size_t len, SSL *ssl, void *arg));
 148 \& void SSL_CTX_set_msg_callback_arg(SSL_CTX *ctx, void *arg);
 149 \&
 150 \& void SSL_set_msg_callback(SSL *ssl,
 151 \&                           void (*cb)(int write_p, int version,
 152 \&                                      int content_type, const void *buf,
 153 \&                                      size_t len, SSL *ssl, void *arg));
 154 \& void SSL_set_msg_callback_arg(SSL *ssl, void *arg);
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 \&\fISSL_CTX_set_msg_callback()\fR or \fISSL_set_msg_callback()\fR can be used to
 159 define a message callback function \fIcb\fR for observing all \s-1SSL/TLS\s0
 160 protocol messages (such as handshake messages) that are received or
 161 sent, as well as other events that occur during processing.
 162 \&\fISSL_CTX_set_msg_callback_arg()\fR and \fISSL_set_msg_callback_arg()\fR
 163 can be used to set argument \fIarg\fR to the callback function, which is
 164 available for arbitrary application use.
 165 .PP
 166 \&\fISSL_CTX_set_msg_callback()\fR and \fISSL_CTX_set_msg_callback_arg()\fR specify
 167 default settings that will be copied to new \fB\s-1SSL\s0\fR objects by
 168 \&\fISSL_new\fR\|(3). \fISSL_set_msg_callback()\fR and
 169 \&\fISSL_set_msg_callback_arg()\fR modify the actual settings of an \fB\s-1SSL\s0\fR
 170 object. Using a \fB\s-1NULL\s0\fR pointer for \fIcb\fR disables the message callback.
 171 .PP
 172 When \fIcb\fR is called by the \s-1SSL/TLS\s0 library the function arguments have the
 173 following meaning:
 174 .IP "\fIwrite_p\fR" 4
 175 .IX Item "write_p"
 176 This flag is \fB0\fR when a protocol message has been received and \fB1\fR
 177 when a protocol message has been sent.
 178 .IP "\fIversion\fR" 4
 179 .IX Item "version"
 180 The protocol version according to which the protocol message is
 181 interpreted by the library such as \fB\s-1TLS1_3_VERSION\s0\fR, \fB\s-1TLS1_2_VERSION\s0\fR etc.
 182 This is set to 0 for the \s-1SSL3_RT_HEADER\s0 pseudo content type (see \s-1NOTES\s0 below).
 183 .IP "\fIcontent_type\fR" 4
 184 .IX Item "content_type"
 185 This is one of the content type values defined in the protocol specification
 186 (\fB\s-1SSL3_RT_CHANGE_CIPHER_SPEC\s0\fR, \fB\s-1SSL3_RT_ALERT\s0\fR, \fB\s-1SSL3_RT_HANDSHAKE\s0\fR; but never
 187 \&\fB\s-1SSL3_RT_APPLICATION_DATA\s0\fR because the callback will only be called for protocol
 188 messages). Alternatively it may be a \*(L"pseudo\*(R" content type. These pseudo
 189 content types are used to signal some other event in the processing of data (see
 190 \&\s-1NOTES\s0 below).
 191 .IP "\fIbuf\fR, \fIlen\fR" 4
 192 .IX Item "buf, len"
 193 \&\fIbuf\fR points to a buffer containing the protocol message or other data (in the
 194 case of pseudo content types), which consists of \fIlen\fR bytes. The buffer is no
 195 longer valid after the callback function has returned.
 196 .IP "\fIssl\fR" 4
 197 .IX Item "ssl"
 198 The \fB\s-1SSL\s0\fR object that received or sent the message.
 199 .IP "\fIarg\fR" 4
 200 .IX Item "arg"
 201 The user-defined argument optionally defined by
 202 \&\fISSL_CTX_set_msg_callback_arg()\fR or \fISSL_set_msg_callback_arg()\fR.
 203 .SH "NOTES"
 204 .IX Header "NOTES"
 205 Protocol messages are passed to the callback function after decryption
 206 and fragment collection where applicable. (Thus record boundaries are
 207 not visible.)
 208 .PP
 209 If processing a received protocol message results in an error,
 210 the callback function may not be called.  For example, the callback
 211 function will never see messages that are considered too large to be
 212 processed.
 213 .PP
 214 Due to automatic protocol version negotiation, \fIversion\fR is not
 215 necessarily the protocol version used by the sender of the message: If
 216 a \s-1TLS 1.0\s0 ClientHello message is received by an \s-1SSL 3\s0.0\-only server,
 217 \&\fIversion\fR will be \fB\s-1SSL3_VERSION\s0\fR.
 218 .PP
 219 Pseudo content type values may be sent at various points during the processing
 220 of data. The following pseudo content types are currently defined:
 221 .IP "\fB\s-1SSL3_RT_HEADER\s0\fR" 4
 222 .IX Item "SSL3_RT_HEADER"
 223 Used when a record is sent or received. The \fBbuf\fR contains the record header
 224 bytes only.
 225 .IP "\fB\s-1SSL3_RT_INNER_CONTENT_TYPE\s0\fR" 4
 226 .IX Item "SSL3_RT_INNER_CONTENT_TYPE"
 227 Used when an encrypted TLSv1.3 record is sent or received. In encrypted TLSv1.3
 228 records the content type in the record header is always
 229 \&\s-1SSL3_RT_APPLICATION_DATA.\s0 The real content type for the record is contained in
 230 an \*(L"inner\*(R" content type. \fBbuf\fR contains the encoded \*(L"inner\*(R" content type byte.
 231 .SH "RETURN VALUES"
 232 .IX Header "RETURN VALUES"
 233 \&\fISSL_CTX_set_msg_callback()\fR, \fISSL_CTX_set_msg_callback_arg()\fR, \fISSL_set_msg_callback()\fR
 234 and \fISSL_set_msg_callback_arg()\fR do not return values.
 235 .SH "SEE ALSO"
 236 .IX Header "SEE ALSO"
 237 \&\fIssl\fR\|(7), \fISSL_new\fR\|(3)
 238 .SH "HISTORY"
 239 .IX Header "HISTORY"
 240 The pseudo content type \fB\s-1SSL3_RT_INNER_CONTENT_TYPE\s0\fR was added in OpenSSL
 241 1.1.1.
 242 .SH "COPYRIGHT"
 243 .IX Header "COPYRIGHT"
 244 Copyright 2001\-2018 The OpenSSL Project Authors. All Rights Reserved.
 245 .PP
 246 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 247 this file except in compliance with the License.  You can obtain a copy
 248 in the file \s-1LICENSE\s0 in the source distribution or at
 249 <https://www.openssl.org/source/license.html>.