xref: /freebsd/crypto/openssl/doc/man3/SSL_get_peer_certificate.pod (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1=pod
2
3=head1 NAME
4
5SSL_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(const SSL *ssl);
12
13=head1 DESCRIPTION
14
15SSL_get_peer_certificate() returns a pointer to the X509 certificate the
16peer presented. If the peer did not present a certificate, NULL is returned.
17
18=head1 NOTES
19
20Due to the protocol definition, a TLS/SSL server will always send a
21certificate, if present. A client will only send a certificate when
22explicitly requested to do so by the server (see
23L<SSL_CTX_set_verify(3)>). If an anonymous cipher
24is used, no certificates are sent.
25
26That a certificate is returned does not indicate information about the
27verification state, use L<SSL_get_verify_result(3)>
28to check the verification state.
29
30The reference count of the X509 object is incremented by one, so that it
31will not be destroyed when the session containing the peer certificate is
32freed. The X509 object must be explicitly freed using X509_free().
33
34=head1 RETURN VALUES
35
36The following return values can occur:
37
38=over 4
39
40=item NULL
41
42No certificate was presented by the peer or no connection was established.
43
44=item Pointer to an X509 certificate
45
46The return value points to the certificate presented by the peer.
47
48=back
49
50=head1 SEE ALSO
51
52L<ssl(7)>, L<SSL_get_verify_result(3)>,
53L<SSL_CTX_set_verify(3)>
54
55=head1 COPYRIGHT
56
57Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
58
59Licensed under the OpenSSL license (the "License").  You may not use
60this file except in compliance with the License.  You can obtain a copy
61in the file LICENSE in the source distribution or at
62L<https://www.openssl.org/source/license.html>.
63
64=cut
65