summaryrefslogtreecommitdiff
path: root/crypto/openssl/doc/ssl/SSL_get_peer_certificate.pod
diff options
context:
space:
mode:
authorcvs2svn <cvs2svn@FreeBSD.org>2002-07-03 13:01:42 +0000
committercvs2svn <cvs2svn@FreeBSD.org>2002-07-03 13:01:42 +0000
commitdb0a3b09965d55f9dee7a58fb04e31df42b6ae73 (patch)
tree15796774b99f140ef7279f6e0a9e8762ca56f414 /crypto/openssl/doc/ssl/SSL_get_peer_certificate.pod
parentb8fd368d376570f335654782a15814d70c9d21c6 (diff)
parent7194701a4d8d2a0fc75c1b41fcb2a9447ed3a4ca (diff)
Notes
Diffstat (limited to 'crypto/openssl/doc/ssl/SSL_get_peer_certificate.pod')
-rw-r--r--crypto/openssl/doc/ssl/SSL_get_peer_certificate.pod48
1 files changed, 48 insertions, 0 deletions
diff --git a/crypto/openssl/doc/ssl/SSL_get_peer_certificate.pod b/crypto/openssl/doc/ssl/SSL_get_peer_certificate.pod
new file mode 100644
index 000000000000..1102c7fba904
--- /dev/null
+++ b/crypto/openssl/doc/ssl/SSL_get_peer_certificate.pod
@@ -0,0 +1,48 @@
+=pod
+
+=head1 NAME
+
+SSL_get_peer_certificate - get the X509 certificate of the peer
+
+=head1 SYNOPSIS
+
+ #include <openssl/ssl.h>
+
+ X509 *SSL_get_peer_certificate(SSL *ssl);
+
+=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
+
+That a certificate is returned does not indicate information about the
+verification state, use L<SSL_get_verify_result(3)|SSL_get_verify_result(3)>
+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
+freed. The X509 object must be explicitly freed using X509_free().
+
+=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
+
+L<ssl(3)|ssl(3)>, L<SSL_get_verify_result(3)|SSL_get_verify_result(3)>
+
+=cut