summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin Jerebica <jerebicakevin@gmail.com>2024-01-16 16:30:26 +0100
committerTomas Mraz <tomas@openssl.org>2024-01-18 10:45:20 +0100
commit9847bc91b3e62983628074cf16be876b822621e5 (patch)
tree5dd2cc41b361a65b4fd7fdbed2abab2c0a1c658c
parent9ff970674b296f6b53f41e77d81beac7e8526cac (diff)
Add a deprecation warning for a function in docs
The function in question is SSL_get_peer_certificate() CLA: trivial Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/23315) (cherry picked from commit 3e938453be47751d50917e25b8f7334b482844b3)
-rw-r--r--doc/man3/SSL_get_peer_certificate.pod7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/man3/SSL_get_peer_certificate.pod b/doc/man3/SSL_get_peer_certificate.pod
index b695edc689..7885188eed 100644
--- a/doc/man3/SSL_get_peer_certificate.pod
+++ b/doc/man3/SSL_get_peer_certificate.pod
@@ -10,10 +10,15 @@ SSL_get1_peer_certificate - get the X509 certificate of the peer
#include <openssl/ssl.h>
- X509 *SSL_get_peer_certificate(const SSL *ssl);
X509 *SSL_get0_peer_certificate(const SSL *ssl);
X509 *SSL_get1_peer_certificate(const SSL *ssl);
+The following function has been deprecated since OpenSSL 3.0,
+and can be hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable
+version value, see L<openssl_user_macros(7)>:
+
+ X509 *SSL_get_peer_certificate(const SSL *ssl);
+
=head1 DESCRIPTION
These functions return a pointer to the X509 certificate the