.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "SSL_CTX_use_psk_identity_hint 3"
.TH SSL_CTX_use_psk_identity_hint 3 2019-12-20 1.0.2u OpenSSL
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
SSL_CTX_use_psk_identity_hint, SSL_use_psk_identity_hint,
SSL_CTX_set_psk_server_callback, SSL_set_psk_server_callback \- set PSK
identity hint to use
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
\&
\& int SSL_CTX_use_psk_identity_hint(SSL_CTX *ctx, const char *hint);
\& int SSL_use_psk_identity_hint(SSL *ssl, const char *hint);
\&
\& void SSL_CTX_set_psk_server_callback(SSL_CTX *ctx,
\&        unsigned int (*callback)(SSL *ssl, const char *identity,
\&        unsigned char *psk, int max_psk_len));
\& void SSL_set_psk_server_callback(SSL *ssl,
\&        unsigned int (*callback)(SSL *ssl, const char *identity,
\&        unsigned char *psk, int max_psk_len));
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBSSL_CTX_use_psk_identity_hint()\fR sets the given \fBNULL\fR\-terminated PSK
identity hint \fBhint\fR to SSL context object
\&\fBctx\fR. \fBSSL_use_psk_identity_hint()\fR sets the given \fBNULL\fR\-terminated
PSK identity hint \fBhint\fR to SSL connection object \fBssl\fR. If \fBhint\fR
is \fBNULL\fR the current hint from \fBctx\fR or \fBssl\fR is deleted.
.PP
In the case where PSK identity hint is \fBNULL\fR, the server
does not send the ServerKeyExchange message to the client.
.PP
A server application must provide a callback function which is called
when the server receives the ClientKeyExchange message from the
client. The purpose of the callback function is to validate the
received PSK identity and to fetch the pre-shared key used during the
connection setup phase. The callback is set using functions
\&\fBSSL_CTX_set_psk_server_callback()\fR or
\&\fBSSL_set_psk_server_callback()\fR. The callback function is given the
connection in parameter \fBssl\fR, \fBNULL\fR\-terminated PSK identity sent
by the client in parameter \fBidentity\fR, and a buffer \fBpsk\fR of length
\&\fBmax_psk_len\fR bytes where the pre-shared key is to be stored.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
\&\fBSSL_CTX_use_psk_identity_hint()\fR and \fBSSL_use_psk_identity_hint()\fR return
1 on success, 0 otherwise.
.PP
Return values from the server callback are interpreted as follows:
.IP 0 4
PSK identity was not found. An "unknown_psk_identity" alert message
will be sent and the connection setup fails.
.IP >0 4
.IX Item ">0"
PSK identity was found and the server callback has provided the PSK
successfully in parameter \fBpsk\fR. Return value is the length of
\&\fBpsk\fR in bytes. It is an error to return a value greater than
\&\fBmax_psk_len\fR.
.Sp
If the PSK identity was not found but the callback instructs the
protocol to continue anyway, the callback must provide some random
data to \fBpsk\fR and return the length of the random data, so the
connection will fail with decryption_error before it will be finished
completely.