secure/lib/libcrypto/man/SSL_CTX_set_psk_client_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_PSK_CLIENT_CALLBACK 3"
 132 .TH SSL_CTX_SET_PSK_CLIENT_CALLBACK 3 "2018-09-11" "1.1.1" "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_psk_client_cb_func, SSL_psk_use_session_cb_func, SSL_CTX_set_psk_client_callback, SSL_set_psk_client_callback, SSL_CTX_set_psk_use_session_callback, SSL_set_psk_use_session_callback \&\- set PSK client callback
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/ssl.h>
 143 \&
 144 \& typedef int (*SSL_psk_use_session_cb_func)(SSL *ssl, const EVP_MD *md,
 145 \&                                            const unsigned char **id,
 146 \&                                            size_t *idlen,
 147 \&                                            SSL_SESSION **sess);
 148 \&
 149 \&
 150 \& void SSL_CTX_set_psk_use_session_callback(SSL_CTX *ctx,
 151 \&                                           SSL_psk_use_session_cb_func cb);
 152 \& void SSL_set_psk_use_session_callback(SSL *s, SSL_psk_use_session_cb_func cb);
 153 \&
 154 \&
 155 \& typedef unsigned int (*SSL_psk_client_cb_func)(SSL *ssl,
 156 \&                                                const char *hint,
 157 \&                                                char *identity,
 158 \&                                                unsigned int max_identity_len,
 159 \&                                                unsigned char *psk,
 160 \&                                                unsigned int max_psk_len);
 161 \&
 162 \& void SSL_CTX_set_psk_client_callback(SSL_CTX *ctx, SSL_psk_client_cb_func cb);
 163 \& void SSL_set_psk_client_callback(SSL *ssl, SSL_psk_client_cb_func cb);
 164 .Ve
 165 .SH "DESCRIPTION"
 166 .IX Header "DESCRIPTION"
 167 A client application wishing to use TLSv1.3 PSKs should use either
 168 \&\fISSL_CTX_set_psk_use_session_callback()\fR or \fISSL_set_psk_use_session_callback()\fR as
 169 appropriate. These functions cannot be used for TLSv1.2 and below PSKs.
 170 .PP
 171 The callback function is given a pointer to the \s-1SSL\s0 connection in \fBssl\fR.
 172 .PP
 173 The first time the callback is called for a connection the \fBmd\fR parameter is
 174 \&\s-1NULL.\s0 In some circumstances the callback will be called a second time. In that
 175 case the server will have specified a ciphersuite to use already and the \s-1PSK\s0
 176 must be compatible with the digest for that ciphersuite. The digest will be
 177 given in \fBmd\fR. The \s-1PSK\s0 returned by the callback is allowed to be different
 178 between the first and second time it is called.
 179 .PP
 180 On successful completion the callback must store a pointer to an identifier for
 181 the \s-1PSK\s0 in \fB*id\fR. The identifier length in bytes should be stored in \fB*idlen\fR.
 182 The memory pointed to by \fB*id\fR remains owned by the application and should
 183 be freed by it as required at any point after the handshake is complete.
 184 .PP
 185 Additionally the callback should store a pointer to an \s-1SSL_SESSION\s0 object in
 186 \&\fB*sess\fR. This is used as the basis for the \s-1PSK,\s0 and should, at a minimum, have
 187 the following fields set:
 188 .IP "The master key" 4
 189 .IX Item "The master key"
 190 This can be set via a call to \fISSL_SESSION_set1_master_key\fR\|(3).
 191 .IP "A ciphersuite" 4
 192 .IX Item "A ciphersuite"
 193 Only the handshake digest associated with the ciphersuite is relevant for the
 194 \&\s-1PSK\s0 (the server may go on to negotiate any ciphersuite which is compatible with
 195 the digest). The application can use any TLSv1.3 ciphersuite. If \fBmd\fR is
 196 not \s-1NULL\s0 the handshake digest for the ciphersuite should be the same.
 197 The ciphersuite can be set via a call to <\fISSL_SESSION_set_cipher\fR\|(3)>. The
 198 handshake digest of an \s-1SSL_CIPHER\s0 object can be checked using
 199 <\fISSL_CIPHER_get_handshake_digest\fR\|(3)>.
 200 .IP "The protocol version" 4
 201 .IX Item "The protocol version"
 202 This can be set via a call to \fISSL_SESSION_set_protocol_version\fR\|(3) and should
 203 be \s-1TLS1_3_VERSION.\s0
 204 .PP
 205 Additionally the maximum early data value should be set via a call to
 206 \&\fISSL_SESSION_set_max_early_data\fR\|(3) if the \s-1PSK\s0 will be used for sending early
 207 data.
 208 .PP
 209 Alternatively an \s-1SSL_SESSION\s0 created from a previous non-PSK handshake may also
 210 be used as the basis for a \s-1PSK.\s0
 211 .PP
 212 Ownership of the \s-1SSL_SESSION\s0 object is passed to the OpenSSL library and so it
 213 should not be freed by the application.
 214 .PP
 215 It is also possible for the callback to succeed but not supply a \s-1PSK.\s0 In this
 216 case no \s-1PSK\s0 will be sent to the server but the handshake will continue. To do
 217 this the callback should return successfully and ensure that \fB*sess\fR is
 218 \&\s-1NULL.\s0 The contents of \fB*id\fR and \fB*idlen\fR will be ignored.
 219 .PP
 220 A client application wishing to use \s-1PSK\s0 ciphersuites for TLSv1.2 and below must
 221 provide a different callback function. This function will be called when the
 222 client is sending the ClientKeyExchange message to the server.
 223 .PP
 224 The purpose of the callback function is to select the \s-1PSK\s0 identity and
 225 the pre-shared key to use during the connection setup phase.
 226 .PP
 227 The callback is set using functions \fISSL_CTX_set_psk_client_callback()\fR
 228 or \fISSL_set_psk_client_callback()\fR. The callback function is given the
 229 connection in parameter \fBssl\fR, a \fB\s-1NULL\s0\fR\-terminated \s-1PSK\s0 identity hint
 230 sent by the server in parameter \fBhint\fR, a buffer \fBidentity\fR of
 231 length \fBmax_identity_len\fR bytes where the resulting
 232 \&\fB\s-1NUL\s0\fR\-terminated identity is to be stored, and a buffer \fBpsk\fR of
 233 length \fBmax_psk_len\fR bytes where the resulting pre-shared key is to
 234 be stored.
 235 .PP
 236 The callback for use in TLSv1.2 will also work in TLSv1.3 although it is
 237 recommended to use \fISSL_CTX_set_psk_use_session_callback()\fR
 238 or \fISSL_set_psk_use_session_callback()\fR for this purpose instead. If TLSv1.3 has
 239 been negotiated then OpenSSL will first check to see if a callback has been set
 240 via \fISSL_CTX_set_psk_use_session_callback()\fR or \fISSL_set_psk_use_session_callback()\fR
 241 and it will use that in preference. If no such callback is present then it will
 242 check to see if a callback has been set via \fISSL_CTX_set_psk_client_callback()\fR or
 243 \&\fISSL_set_psk_client_callback()\fR and use that. In this case the \fBhint\fR value will
 244 always be \s-1NULL\s0 and the handshake digest will default to \s-1SHA\-256\s0 for any returned
 245 \&\s-1PSK.\s0
 246 .SH "NOTES"
 247 .IX Header "NOTES"
 248 Note that parameter \fBhint\fR given to the callback may be \fB\s-1NULL\s0\fR.
 249 .PP
 250 A connection established via a TLSv1.3 \s-1PSK\s0 will appear as if session resumption
 251 has occurred so that \fISSL_session_reused\fR\|(3) will return true.
 252 .PP
 253 There are no known security issues with sharing the same \s-1PSK\s0 between TLSv1.2 (or
 254 below) and TLSv1.3. However the \s-1RFC\s0 has this note of caution:
 255 .PP
 256 \&\*(L"While there is no known way in which the same \s-1PSK\s0 might produce related output
 257 in both versions, only limited analysis has been done.  Implementations can
 258 ensure safety from cross-protocol related output by not reusing PSKs between
 259 \&\s-1TLS 1.3\s0 and \s-1TLS 1.2.\*(R"\s0
 260 .SH "RETURN VALUES"
 261 .IX Header "RETURN VALUES"
 262 Return values from the \fBSSL_psk_client_cb_func\fR callback are interpreted as
 263 follows:
 264 .PP
 265 On success (callback found a \s-1PSK\s0 identity and a pre-shared key to use)
 266 the length (> 0) of \fBpsk\fR in bytes is returned.
 267 .PP
 268 Otherwise or on errors the callback should return 0. In this case
 269 the connection setup fails.
 270 .PP
 271 The SSL_psk_use_session_cb_func callback should return 1 on success or 0 on
 272 failure. In the event of failure the connection setup fails.
 273 .SH "SEE ALSO"
 274 .IX Header "SEE ALSO"
 275 \&\fISSL_CTX_set_psk_find_session_callback\fR\|(3),
 276 \&\fISSL_set_psk_find_session_callback\fR\|(3)
 277 .SH "HISTORY"
 278 .IX Header "HISTORY"
 279 \&\fISSL_CTX_set_psk_use_session_callback()\fR and \fISSL_set_psk_use_session_callback()\fR
 280 were added in OpenSSL 1.1.1.
 281 .SH "COPYRIGHT"
 282 .IX Header "COPYRIGHT"
 283 Copyright 2006\-2018 The OpenSSL Project Authors. All Rights Reserved.
 284 .PP
 285 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 286 this file except in compliance with the License.  You can obtain a copy
 287 in the file \s-1LICENSE\s0 in the source distribution or at
 288 <https://www.openssl.org/source/license.html>.