Correction from Tani Hosokawa <unknown@riverstyx.net>
[openssl.git] / doc / ssl / SSL_get_peer_certificate.pod
1 =pod
2
3 =head1 NAME
4
5 SSL_get_peer_certificate - get the X509 certificate of the peer
6
7 =head1 SYNOPSIS
8
9  #include <openssl/ssl.h>
10
11  X509 *SSL_get_peer_certificate(SSL *ssl);
12
13 =head1 DESCRIPTION
14
15 SSL_get_peer_certificate() returns a pointer to the X509 certificate the
16 peer presented. If the peer did not present a certificate, NULL is returned.
17
18 =head1 NOTES
19
20 That a certificate is returned does not indicate information about the
21 verification state, use L<SSL_get_verify_result(3)|SSL_get_verify_result(3)>
22 to check the verification state.
23
24 The reference count of the X509 object is incremented by one, so that it
25 will not be destroyed when the session containing the peer certificate is
26 freed. The X509 object must be explicitely freed using X509_free().
27
28 =head1 RETURN VALUES
29
30 The following return values can occur:
31
32 =over 4
33
34 =item NULL
35
36 No certificate was presented by the peer or no connection was established.
37
38 =item Pointer to an X509 certificate
39
40 The return value points to the certificate presented by the peer.
41
42 =back
43
44 =head1 SEE ALSO
45
46 L<ssl(3)|ssl(3)>, L<SSL_get_verify_result(3)|SSL_get_verify_result(3)>
47
48 =cut