secure/lib/libcrypto/man/SSL_CTX_set_psk_client_callback.3

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