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