doc/ssl/SSL_get_peer_cert_chain.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_get_peer_cert_chain, SSL_get0_verified_chain - get the X509 certificate
   6 chain of the peer
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/ssl.h>
  11
  12  STACK_OF(X509) *SSL_get_peer_cert_chain(const SSL *ssl);
  13  STACK_OF(X509) *SSL_get0_verified_chain(const SSL *ssl);
  14
  15 =head1 DESCRIPTION
  16
  17 SSL_get_peer_cert_chain() returns a pointer to STACK_OF(X509) certificates
  18 forming the certificate chain sent by the peer. If called on the client side,
  19 the stack also contains the peer's certificate; if called on the server
  20 side, the peer's certificate must be obtained separately using
  21 L<SSL_get_peer_certificate(3)>.
  22 If the peer did not present a certificate, NULL is returned.
  23
  24 NB: SSL_get_peer_chain() returns the peer chain as sent by the peer: it
  25 only consists of certificates the peer has sent (in the order the peer
  26 has sent them) it is B<not> a verified chain.
  27
  28 SSL_get0_verified_chain() returns the B<verified> certificate chain
  29 of the peer including the peer's end entity certificate. It must be called
  30 after a session has been successfully established. If peer verification was
  31 not successful (as indicated by SSL_get_verify_result() not returning
  32 X509_V_OK) the chain may be incomplete or invalid.
  33
  34 =head1 NOTES
  35
  36 If the session is resumed peers do not send certificates so a NULL pointer
  37 is returned by these functions. Applications can call SSL_session_reused()
  38 to determine whether a session is resumed.
  39
  40 The reference count of each certificate in the returned STACK_OF(X509) object
  41 is not incremented and the returned stack may be invalidated by renegotiation.
  42 If applications wish to use any certificates in the returned chain
  43 indefinitely they must increase the reference counts using X509_up_ref() or
  44 obtain a copy of the whole chain with X509_chain_up_ref().
  45
  46 =head1 RETURN VALUES
  47
  48 The following return values can occur:
  49
  50 =over 4
  51
  52 =item NULL
  53
  54 No certificate was presented by the peer or no connection was established
  55 or the certificate chain is no longer available when a session is reused.
  56
  57 =item Pointer to a STACK_OF(X509)
  58
  59 The return value points to the certificate chain presented by the peer.
  60
  61 =back
  62
  63 =head1 SEE ALSO
  64
  65 L<ssl(3)>, L<SSL_get_peer_certificate(3)>, L<X509_up_ref(3)>,
  66 L<X509_chain_up_ref(3)>
  67
  68 =cut
  69
  70 =head1 COPYRIGHT
  71
  72 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  73
  74 Licensed under the OpenSSL license (the "License").  You may not use
  75 this file except in compliance with the License.  You can obtain a copy
  76 in the file LICENSE in the source distribution or at
  77 L<https://www.openssl.org/source/license.html>.
  78
  79 =cut