Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

SSL_get_peer_cert_chain (3openssl)

Name

SSL_get_peer_cert_chain - get the X509 certificate chain of the peer

Synopsis

#include <openssl/ssl.h>

STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);

Description

OpenSSL                                      SSL_get_peer_cert_chain(3openssl)



NAME
       SSL_get_peer_cert_chain - get the X509 certificate chain of the peer

SYNOPSIS
        #include <openssl/ssl.h>

        STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);

DESCRIPTION
       SSL_get_peer_cert_chain() returns a pointer to STACK_OF(X509)
       certificates forming the certificate chain of the peer. If called on
       the client side, the stack also contains the peer's certificate; if
       called on the server side, the peer's certificate must be obtained
       separately using SSL_get_peer_certificate(3).  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
       The peer certificate chain is not necessarily available after reusing a
       session, in which case a NULL pointer is returned.

       The reference count of the STACK_OF(X509) object is not incremented.
       If the corresponding session is freed, the pointer must not be used any
       longer.

       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 or the certificate chain is no longer available when a
           session is reused.

       Pointer to a STACK_OF(X509)
           The return value points to the certificate chain presented by the
           peer.

SEE ALSO
       ssl(3), SSL_get_peer_certificate(3)




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