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

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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_USE_PSK_IDENTITY_HINT 3"
 136 .TH SSL_CTX_USE_PSK_IDENTITY_HINT 3 "2020-03-31" "1.1.1f" "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_server_cb_func, SSL_psk_find_session_cb_func, SSL_CTX_use_psk_identity_hint, SSL_use_psk_identity_hint, SSL_CTX_set_psk_server_callback, SSL_set_psk_server_callback, SSL_CTX_set_psk_find_session_callback, SSL_set_psk_find_session_callback \&\- set PSK identity hint to use
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/ssl.h>
 147 \&
 148 \& typedef int (*SSL_psk_find_session_cb_func)(SSL *ssl,
 149 \&                                             const unsigned char *identity,
 150 \&                                             size_t identity_len,
 151 \&                                             SSL_SESSION **sess);
 152 \&
 153 \&
 154 \& void SSL_CTX_set_psk_find_session_callback(SSL_CTX *ctx,
 155 \&                                            SSL_psk_find_session_cb_func cb);
 156 \& void SSL_set_psk_find_session_callback(SSL *s, SSL_psk_find_session_cb_func cb);
 157 \&
 158 \& typedef unsigned int (*SSL_psk_server_cb_func)(SSL *ssl,
 159 \&                                                const char *identity,
 160 \&                                                unsigned char *psk,
 161 \&                                                unsigned int max_psk_len);
 162 \&
 163 \& int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *hint);
 164 \& int SSL_use_psk_identity_hint(SSL *ssl, const char *hint);
 165 \&
 166 \& void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx, SSL_psk_server_cb_func cb);
 167 \& void SSL_set_psk_server_callback(SSL *ssl, SSL_psk_server_cb_func cb);
 168 .Ve
 169 .SH "DESCRIPTION"
 170 .IX Header "DESCRIPTION"
 171 A server application wishing to use TLSv1.3 PSKs should set a callback
 172 using either \fBSSL_CTX_set_psk_find_session_callback()\fR or
 173 \&\fBSSL_set_psk_find_session_callback()\fR as appropriate.
 174 .PP
 175 The callback function is given a pointer to the \s-1SSL\s0 connection in \fBssl\fR and
 176 an identity in \fBidentity\fR of length \fBidentity_len\fR. The callback function
 177 should identify an \s-1SSL_SESSION\s0 object that provides the \s-1PSK\s0 details and store it
 178 in \fB*sess\fR. The \s-1SSL_SESSION\s0 object should, as a minimum, set the master key,
 179 the ciphersuite and the protocol version. See
 180 \&\fBSSL_CTX_set_psk_use_session_callback\fR\|(3) for details.
 181 .PP
 182 It is also possible for the callback to succeed but not supply a \s-1PSK.\s0 In this
 183 case no \s-1PSK\s0 will be used but the handshake will continue. To do this the
 184 callback should return successfully and ensure that \fB*sess\fR is
 185 \&\s-1NULL.\s0
 186 .PP
 187 Identity hints are not relevant for TLSv1.3. A server application wishing to use
 188 \&\s-1PSK\s0 ciphersuites for TLSv1.2 and below may call \fBSSL_CTX_use_psk_identity_hint()\fR
 189 to set the given \fB\s-1NUL\s0\fR\-terminated \s-1PSK\s0 identity hint \fBhint\fR for \s-1SSL\s0 context
 190 object \fBctx\fR. \fBSSL_use_psk_identity_hint()\fR sets the given \fB\s-1NUL\s0\fR\-terminated \s-1PSK\s0
 191 identity hint \fBhint\fR for the \s-1SSL\s0 connection object \fBssl\fR. If \fBhint\fR is
 192 \&\fB\s-1NULL\s0\fR the current hint from \fBctx\fR or \fBssl\fR is deleted.
 193 .PP
 194 In the case where \s-1PSK\s0 identity hint is \fB\s-1NULL\s0\fR, the server does not send the
 195 ServerKeyExchange message to the client.
 196 .PP
 197 A server application wishing to use PSKs for TLSv1.2 and below must provide a
 198 callback function which is called when the server receives the
 199 ClientKeyExchange message from the client. The purpose of the callback function
 200 is to validate the received \s-1PSK\s0 identity and to fetch the pre-shared key used
 201 during the connection setup phase. The callback is set using the functions
 202 \&\fBSSL_CTX_set_psk_server_callback()\fR or \fBSSL_set_psk_server_callback()\fR. The callback
 203 function is given the connection in parameter \fBssl\fR, \fB\s-1NUL\s0\fR\-terminated \s-1PSK\s0
 204 identity sent by the client in parameter \fBidentity\fR, and a buffer \fBpsk\fR of
 205 length \fBmax_psk_len\fR bytes where the pre-shared key is to be stored.
 206 .PP
 207 The callback for use in TLSv1.2 will also work in TLSv1.3 although it is
 208 recommended to use \fBSSL_CTX_set_psk_find_session_callback()\fR
 209 or \fBSSL_set_psk_find_session_callback()\fR for this purpose instead. If TLSv1.3 has
 210 been negotiated then OpenSSL will first check to see if a callback has been set
 211 via \fBSSL_CTX_set_psk_find_session_callback()\fR or \fBSSL_set_psk_find_session_callback()\fR
 212 and it will use that in preference. If no such callback is present then it will
 213 check to see if a callback has been set via \fBSSL_CTX_set_psk_server_callback()\fR or
 214 \&\fBSSL_set_psk_server_callback()\fR and use that. In this case the handshake digest
 215 will default to \s-1SHA\-256\s0 for any returned \s-1PSK.\s0
 216 .SH "NOTES"
 217 .IX Header "NOTES"
 218 A connection established via a TLSv1.3 \s-1PSK\s0 will appear as if session resumption
 219 has occurred so that \fBSSL_session_reused\fR\|(3) will return true.
 220 .SH "RETURN VALUES"
 221 .IX Header "RETURN VALUES"
 222 \&\fB\fBSSL_CTX_use_psk_identity_hint()\fB\fR and \fB\fBSSL_use_psk_identity_hint()\fB\fR return
 223 1 on success, 0 otherwise.
 224 .PP
 225 Return values from the TLSv1.2 and below server callback are interpreted as
 226 follows:
 227 .IP "0" 4
 228 \&\s-1PSK\s0 identity was not found. An \*(L"unknown_psk_identity\*(R" alert message
 229 will be sent and the connection setup fails.
 230 .IP ">0" 4
 231 .IX Item ">0"
 232 \&\s-1PSK\s0 identity was found and the server callback has provided the \s-1PSK\s0
 233 successfully in parameter \fBpsk\fR. Return value is the length of
 234 \&\fBpsk\fR in bytes. It is an error to return a value greater than
 235 \&\fBmax_psk_len\fR.
 236 .Sp
 237 If the \s-1PSK\s0 identity was not found but the callback instructs the
 238 protocol to continue anyway, the callback must provide some random
 239 data to \fBpsk\fR and return the length of the random data, so the
 240 connection will fail with decryption_error before it will be finished
 241 completely.
 242 .PP
 243 The \fBSSL_psk_find_session_cb_func\fR callback should return 1 on success or 0 on
 244 failure. In the event of failure the connection setup fails.
 245 .SH "NOTES"
 246 .IX Header "NOTES"
 247 There are no known security issues with sharing the same \s-1PSK\s0 between TLSv1.2 (or
 248 below) and TLSv1.3. However the \s-1RFC\s0 has this note of caution:
 249 .PP
 250 \&\*(L"While there is no known way in which the same \s-1PSK\s0 might produce related output
 251 in both versions, only limited analysis has been done.  Implementations can
 252 ensure safety from cross-protocol related output by not reusing PSKs between
 253 \&\s-1TLS 1.3\s0 and \s-1TLS 1.2.\*(R"\s0
 254 .SH "SEE ALSO"
 255 .IX Header "SEE ALSO"
 256 \&\fBSSL_CTX_set_psk_use_session_callback\fR\|(3),
 257 \&\fBSSL_set_psk_use_session_callback\fR\|(3)
 258 .SH "HISTORY"
 259 .IX Header "HISTORY"
 260 \&\fBSSL_CTX_set_psk_find_session_callback()\fR and \fBSSL_set_psk_find_session_callback()\fR
 261 were added in OpenSSL 1.1.1.
 262 .SH "COPYRIGHT"
 263 .IX Header "COPYRIGHT"
 264 Copyright 2006\-2018 The OpenSSL Project Authors. All Rights Reserved.
 265 .PP
 266 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 267 this file except in compliance with the License.  You can obtain a copy
 268 in the file \s-1LICENSE\s0 in the source distribution or at
 269 <https://www.openssl.org/source/license.html>.