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