Move manpages to man[1357] structure.
[openssl.git] / doc / man3 / SSL_get_psk_identity.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_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
15 =head1 DESCRIPTION
16
17 SSL_get_psk_identity_hint() is used to retrieve the PSK identity hint
18 used during the connection setup related to SSL object
19 B<ssl>. Similarly, SSL_get_psk_identity() is used to retrieve the PSK
20 identity used during the connection setup.
21
22
23 =head1 RETURN VALUES
24
25 If non-B<NULL>, SSL_get_psk_identity_hint() returns the PSK identity
26 hint and SSL_get_psk_identity() returns the PSK identity. Both are
27 B<NULL>-terminated. SSL_get_psk_identity_hint() may return B<NULL> if
28 no PSK identity hint was used during the connection setup.
29
30 Note that the return value is valid only during the lifetime of the
31 SSL object B<ssl>.
32
33 =head1 COPYRIGHT
34
35 Copyright 2006-2016 The OpenSSL Project Authors. All Rights Reserved.
36
37 Licensed under the OpenSSL license (the "License").  You may not use
38 this file except in compliance with the License.  You can obtain a copy
39 in the file LICENSE in the source distribution or at
40 L<https://www.openssl.org/source/license.html>.
41
42 Copyright 2005 Nokia.
43
44 =cut