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