xref: /openssl/doc/man3/SSL_get_psk_identity.pod (revision 98ca37e4)
1=pod
2
3=head1 NAME
4
5SSL_get_psk_identity, SSL_get_psk_identity_hint - get PSK client identity and hint
6
7=head1 SYNOPSIS
8
9 #include <openssl/ssl.h>
10
11 const char *SSL_get_psk_identity_hint(const SSL *ssl);
12 const char *SSL_get_psk_identity(const SSL *ssl);
13
14=head1 DESCRIPTION
15
16SSL_get_psk_identity_hint() is used to retrieve the PSK identity hint
17used during the connection setup related to SSL object
18B<ssl>. Similarly, SSL_get_psk_identity() is used to retrieve the PSK
19identity used during the connection setup.
20
21
22=head1 RETURN VALUES
23
24If non-B<NULL>, SSL_get_psk_identity_hint() returns the PSK identity
25hint and SSL_get_psk_identity() returns the PSK identity. Both are
26B<NULL>-terminated. SSL_get_psk_identity_hint() may return B<NULL> if
27no PSK identity hint was used during the connection setup.
28
29Note that the return value is valid only during the lifetime of the
30SSL object B<ssl>.
31
32=head1 SEE ALSO
33
34L<ssl(7)>
35
36=head1 COPYRIGHT
37
38Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
39
40Licensed under the Apache License 2.0 (the "License").  You may not use
41this file except in compliance with the License.  You can obtain a copy
42in the file LICENSE in the source distribution or at
43L<https://www.openssl.org/source/license.html>.
44
45=cut
46