lib/libssl/man/SSL_CTX_set_msg_callback.3

   1 .\"     $OpenBSD: SSL_CTX_set_msg_callback.3,v 1.3 2017/08/21 09:07:08 schwarze Exp $
   2 .\"     OpenSSL SSL_CTX_set_msg_callback.pod e9b77246 Jan 20 19:58:49 2017 +0100
   3 .\"     OpenSSL SSL_CTX_set_msg_callback.pod b97fdb57 Nov 11 09:33:09 2016 +0100
   4 .\"
   5 .\" This file was written by Bodo Moeller <bodo@openssl.org>.
   6 .\" Copyright (c) 2001, 2014, 2016 The OpenSSL Project.  All rights reserved.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\"
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\"
  15 .\" 2. Redistributions in binary form must reproduce the above copyright
  16 .\"    notice, this list of conditions and the following disclaimer in
  17 .\"    the documentation and/or other materials provided with the
  18 .\"    distribution.
  19 .\"
  20 .\" 3. All advertising materials mentioning features or use of this
  21 .\"    software must display the following acknowledgment:
  22 .\"    "This product includes software developed by the OpenSSL Project
  23 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  24 .\"
  25 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  26 .\"    endorse or promote products derived from this software without
  27 .\"    prior written permission. For written permission, please contact
  28 .\"    openssl-core@openssl.org.
  29 .\"
  30 .\" 5. Products derived from this software may not be called "OpenSSL"
  31 .\"    nor may "OpenSSL" appear in their names without prior written
  32 .\"    permission of the OpenSSL Project.
  33 .\"
  34 .\" 6. Redistributions of any form whatsoever must retain the following
  35 .\"    acknowledgment:
  36 .\"    "This product includes software developed by the OpenSSL Project
  37 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  38 .\"
  39 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  40 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  41 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  42 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  43 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  44 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  45 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  46 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  47 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  48 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  49 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  50 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  51 .\"
  52 .Dd $Mdocdate: August 21 2017 $
  53 .Dt SSL_CTX_SET_MSG_CALLBACK 3
  54 .Os
  55 .Sh NAME
  56 .Nm SSL_CTX_set_msg_callback ,
  57 .Nm SSL_CTX_set_msg_callback_arg ,
  58 .Nm SSL_set_msg_callback ,
  59 .Nm SSL_set_msg_callback_arg
  60 .Nd install callback for observing protocol messages
  61 .Sh SYNOPSIS
  62 .In openssl/ssl.h
  63 .Ft void
  64 .Fo SSL_CTX_set_msg_callback
  65 .Fa "SSL_CTX *ctx"
  66 .Fa "void (*cb)(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg)"
  67 .Fc
  68 .Ft void
  69 .Fn SSL_CTX_set_msg_callback_arg "SSL_CTX *ctx" "void *arg"
  70 .Ft void
  71 .Fo SSL_set_msg_callback
  72 .Fa "SSL *ssl"
  73 .Fa "void (*cb)(int write_p, int version, int content_type, const void *buf, size_t len, SSL *ssl, void *arg)"
  74 .Fc
  75 .Ft void
  76 .Fn SSL_set_msg_callback_arg "SSL *ssl" "void *arg"
  77 .Sh DESCRIPTION
  78 .Fn SSL_CTX_set_msg_callback
  79 or
  80 .Fn SSL_set_msg_callback
  81 can be used to define a message callback function
  82 .Fa cb
  83 for observing all SSL/TLS protocol messages (such as handshake messages)
  84 that are received or sent.
  85 .Fn SSL_CTX_set_msg_callback_arg
  86 and
  87 .Fn SSL_set_msg_callback_arg
  88 can be used to set argument
  89 .Fa arg
  90 to the callback function, which is available for arbitrary application use.
  91 .Pp
  92 .Fn SSL_CTX_set_msg_callback
  93 and
  94 .Fn SSL_CTX_set_msg_callback_arg
  95 specify default settings that will be copied to new
  96 .Vt SSL
  97 objects by
  98 .Xr SSL_new 3 .
  99 .Fn SSL_set_msg_callback
 100 and
 101 .Fn SSL_set_msg_callback_arg
 102 modify the actual settings of an
 103 .Vt SSL
 104 object.
 105 Using a
 106 .Dv NULL
 107 pointer for
 108 .Fa cb
 109 disables the message callback.
 110 .Pp
 111 When
 112 .Fa cb
 113 is called by the SSL/TLS library for a protocol message,
 114 the function arguments have the following meaning:
 115 .Bl -tag -width Ds
 116 .It Fa write_p
 117 This flag is 0 when a protocol message has been received and 1 when a protocol
 118 message has been sent.
 119 .It Fa version
 120 The protocol version according to which the protocol message is
 121 interpreted by the library, such as
 122 .Dv TLS1_VERSION ,
 123 .Dv TLS1_1_VERSION ,
 124 .Dv TLS1_2_VERSION ,
 125 or
 126 .Dv DTLS1_VERSION .
 127 .It Fa content_type
 128 This is one of the
 129 .Em ContentType
 130 values defined in the protocol specification
 131 .Po
 132 .Dv SSL3_RT_CHANGE_CIPHER_SPEC ,
 133 .Dv SSL3_RT_ALERT ,
 134 .Dv SSL3_RT_HANDSHAKE ,
 135 but never
 136 .Dv SSL3_RT_APPLICATION_DATA
 137 because the callback will only be called for protocol messages.
 138 .Pc
 139 .It Fa buf , Fa len
 140 .Fa buf
 141 points to a buffer containing the protocol message, which consists of
 142 .Fa len
 143 bytes.
 144 The buffer is no longer valid after the callback function has returned.
 145 .It Fa ssl
 146 The
 147 .Vt SSL
 148 object that received or sent the message.
 149 .It Fa arg
 150 The user-defined argument optionally defined by
 151 .Fn SSL_CTX_set_msg_callback_arg
 152 or
 153 .Fn SSL_set_msg_callback_arg .
 154 .El
 155 .Pp
 156 Protocol messages are passed to the callback function after decryption
 157 and fragment collection where applicable.
 158 (Thus record boundaries are not visible.)
 159 .Pp
 160 If processing a received protocol message results in an error,
 161 the callback function may not be called.
 162 For example, the callback function will never see messages that are considered
 163 too large to be processed.
 164 .Pp
 165 Due to automatic protocol version negotiation,
 166 .Fa version
 167 is not necessarily the protocol version used by the sender of the message:
 168 If a TLS 1.0 ClientHello message is received by an SSL 3.0-only server,
 169 .Fa version
 170 will be
 171 .Dv SSL3_VERSION .
 172 .Sh SEE ALSO
 173 .Xr ssl 3 ,
 174 .Xr SSL_new 3
 175 .Sh HISTORY
 176 .Fn SSL_CTX_set_msg_callback ,
 177 .Fn SSL_CTX_set_msg_callback_arg ,
 178 .Fn SSL_set_msg_callback
 179 and
 180 .Fn SSL_set_msg_callback_arg
 181 were added in OpenSSL 0.9.7.