SSL_get_peer_certificate.pod 1.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10
=pod

=head1 NAME

SSL_get_peer_certificate - get the X509 certificate of the peer

=head1 SYNOPSIS

 #include <openssl/ssl.h>

11
 X509 *SSL_get_peer_certificate(const SSL *ssl);
12 13 14 15 16 17 18 19

=head1 DESCRIPTION

SSL_get_peer_certificate() returns a pointer to the X509 certificate the
peer presented. If the peer did not present a certificate, NULL is returned.

=head1 NOTES

20 21
Due to the protocol definition, a TLS/SSL server will always send a
certificate, if present. A client will only send a certificate when
U
ispell  
Ulf Möller 已提交
22
explicitly requested to do so by the server (see
R
Rich Salz 已提交
23
L<SSL_CTX_set_verify(3)>). If an anonymous cipher
24 25
is used, no certificates are sent.

26
That a certificate is returned does not indicate information about the
R
Rich Salz 已提交
27
verification state, use L<SSL_get_verify_result(3)>
28 29 30 31
to check the verification state.

The reference count of the X509 object is incremented by one, so that it
will not be destroyed when the session containing the peer certificate is
U
ispell  
Ulf Möller 已提交
32
freed. The X509 object must be explicitly freed using X509_free().
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51

=head1 RETURN VALUES

The following return values can occur:

=over 4

=item NULL

No certificate was presented by the peer or no connection was established.

=item Pointer to an X509 certificate

The return value points to the certificate presented by the peer.

=back

=head1 SEE ALSO

R
Rich Salz 已提交
52 53
L<ssl(3)>, L<SSL_get_verify_result(3)>,
L<SSL_CTX_set_verify(3)>
54 55

=cut
R
Rich Salz 已提交
56 57 58 59 60 61 62 63 64 65 66

=head1 COPYRIGHT

Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut