diff options
author | Richard Levitte <levitte@openssl.org> | 2000-09-20 16:55:26 +0000 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2000-09-20 16:55:26 +0000 |
commit | 4759abc5f268710bb5b75b38152958d7a1a3f95f (patch) | |
tree | 81ac900b9895ed8297803357c40df651788b115d /doc/ssl/SSL_get_peer_certificate.pod | |
parent | e31e385ce3d788f0e9e2b6acd24c494a8338ab49 (diff) |
New documents. Lutz Jaenicke <Lutz.Jaenicke@aet.TU-Cottbus.DE>
Diffstat (limited to 'doc/ssl/SSL_get_peer_certificate.pod')
-rw-r--r-- | doc/ssl/SSL_get_peer_certificate.pod | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/doc/ssl/SSL_get_peer_certificate.pod b/doc/ssl/SSL_get_peer_certificate.pod new file mode 100644 index 0000000000..79c089aa51 --- /dev/null +++ b/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 explicitely 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 |