doc/ssl/SSL_get_peer_cert_chain.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_get_peer_cert_chain - get the X509 certificate chain of the peer
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/ssl.h>
  10
  11  STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);
  12
  13 =head1 DESCRIPTION
  14
  15 SSL_get_peer_cert_chain() returns a pointer to STACK_OF(X509) certificates
  16 forming the certificate chain of the peer. If called on the client side,
  17 the stack also contains the peer's certificate; if called on the server
  18 side, the peer's certificate must be obtained separately using
  19 L<SSL_get_peer_certificate(3)|SSL_get_peer_certificate(3)>.
  20 If the peer did not present a certificate, NULL is returned.
  21
  22 =head1 NOTES
  23
  24 The peer certificate chain is not necessarily available after reusing
  25 a session, in which case a NULL pointer is returned.
  26
  27 The reference count of the STACK_OF(X509) object is not incremented.
  28 If the corresponding session is freed, the pointer must not be used
  29 any longer.
  30
  31 =head1 RETURN VALUES
  32
  33 The following return values can occur:
  34
  35 =over 4
  36
  37 =item NULL
  38
  39 No certificate was presented by the peer or no connection was established
  40 or the certificate chain is no longer available when a session is reused.
  41
  42 =item Pointer to a STACK_OF(X509)
  43
  44 The return value points to the certificate chain presented by the peer.
  45
  46 =back
  47
  48 =head1 SEE ALSO
  49
  50 L<ssl(3)|ssl(3)>, L<SSL_get_peer_certificate(3)|SSL_get_peer_certificate(3)>
  51
  52 =cut