secure/lib/libcrypto/man/man3/SSL_CTX_set_msg_callback.3

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