Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_get_peer_certificate (3openssl)

Name

SSL_get_peer_certificate - get the X509 certificate of the peer

Synopsis

#include <openssl/ssl.h>

X509 *SSL_get_peer_certificate(const SSL *ssl);

Description

OpenSSL                                     SSL_get_peer_certificate(3openssl)



NAME
       SSL_get_peer_certificate - get the X509 certificate of the peer

SYNOPSIS
        #include <openssl/ssl.h>

        X509 *SSL_get_peer_certificate(const SSL *ssl);

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.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | library/security/openssl |
       +---------------+--------------------------+
       |Stability      | Pass-through uncommitted |
       +---------------+--------------------------+

NOTES
       Due to the protocol definition, a TLS/SSL server will always send a
       certificate, if present. A client will only send a certificate when
       explicitly requested to do so by the server (see
       SSL_CTX_set_verify(3)). If an anonymous cipher is used, no certificates
       are sent.

       That a certificate is returned does not indicate information about the
       verification state, use 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().

       Source code for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This software was built from source available at
       https://github.com/oracle/solaris-userland.  The original community
       source was downloaded from
       https://www.openssl.org/source/openssl-1.0.2ze.tar.gz.

       Further information about this software can be found on the open source
       community website at https://www.openssl.org/.

RETURN VALUES
       The following return values can occur:

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

       Pointer to an X509 certificate
           The return value points to the certificate presented by the peer.

SEE ALSO
       ssl(3), SSL_get_verify_result(3), SSL_CTX_set_verify(3)




1.0.2ze                           2022-05-03
                                            SSL_get_peer_certificate(3openssl)