Correct PPTP server firewall rules chain.
[tomato/davidwu.git] / release / src / router / openssl / doc / ssl / SSL_get_psk_identity.pod
blobfe6291649ceee3fbfaa4027b213c25bbbcb7ec5d
1 =pod
3 =begin comment
5 Copyright 2005 Nokia. All rights reserved.
7 The portions of the attached software ("Contribution") is developed by
8 Nokia Corporation and is licensed pursuant to the OpenSSL open source
9 license.
11 The Contribution, originally written by Mika Kousa and Pasi Eronen of
12 Nokia Corporation, consists of the "PSK" (Pre-Shared Key) ciphersuites
13 support (see RFC 4279) to OpenSSL.
15 No patent licenses or other rights except those expressly stated in
16 the OpenSSL open source license shall be deemed granted or received
17 expressly, by implication, estoppel, or otherwise.
19 No assurances are provided by Nokia that the Contribution does not
20 infringe the patent or other intellectual property rights of any third
21 party or that the license provides you with all the necessary rights
22 to make use of the Contribution.
24 THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN
25 ADDITION TO THE DISCLAIMERS INCLUDED IN THE LICENSE, NOKIA
26 SPECIFICALLY DISCLAIMS ANY LIABILITY FOR CLAIMS BROUGHT BY YOU OR ANY
27 OTHER ENTITY BASED ON INFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OR
28 OTHERWISE.
30 =end comment
32 =head1 NAME
34 SSL_get_psk_identity, SSL_get_psk_identity_hint - get PSK client identity and hint
37 =head1 SYNOPSIS
39  #include <openssl/ssl.h>
41  const char *SSL_get_psk_identity_hint(const SSL *ssl);
42  const char *SSL_get_psk_identity(const SSL *ssl);
45 =head1 DESCRIPTION
47 SSL_get_psk_identity_hint() is used to retrieve the PSK identity hint
48 used during the connection setup related to SSL object
49 B<ssl>. Similarly, SSL_get_psk_identity() is used to retrieve the PSK
50 identity used during the connection setup.
53 =head1 RETURN VALUES
55 If non-B<NULL>, SSL_get_psk_identity_hint() returns the PSK identity
56 hint and SSL_get_psk_identity() returns the PSK identity. Both are
57 B<NULL>-terminated. SSL_get_psk_identity_hint() may return B<NULL> if
58 no PSK identity hint was used during the connection setup.
60 Note that the return value is valid only during the lifetime of the
61 SSL object B<ssl>.
63 =cut