doc/ssl/SSL_CTX_add_extra_chain_cert.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 SSL_CTX_add_extra_chain_cert, SSL_CTX_clear_extra_chain_certs - add or clear
   6 extra chain certificates
   7
   8 =head1 SYNOPSIS
   9
  10  #include <openssl/ssl.h>
  11
  12  long SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
  13  long SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
  14
  15 =head1 DESCRIPTION
  16
  17 SSL_CTX_add_extra_chain_cert() adds the certificate B<x509> to the extra chain
  18 certificates associated with B<ctx>. Several certificates can be added one
  19 after another.
  20
  21 SSL_CTX_clear_extra_chain_certs() clears all extra chain certificates
  22 associated with B<ctx>.
  23
  24 These functions are implemented as macros.
  25
  26 =head1 NOTES
  27
  28 When sending a certificate chain, extra chain certificates are sent in order
  29 following the end entity certificate.
  30
  31 If no chain is specified, the library will try to complete the chain from the
  32 available CA certificates in the trusted CA storage, see
  33 L<SSL_CTX_load_verify_locations(3)>.
  34
  35 The B<x509> certificate provided to SSL_CTX_add_extra_chain_cert() will be
  36 freed by the library when the B<SSL_CTX> is destroyed. An application
  37 B<should not> free the B<x509> object.
  38
  39 =head1 RESTRICTIONS
  40
  41 Only one set of extra chain certificates can be specified per SSL_CTX
  42 structure. Different chains for different certificates (for example if both
  43 RSA and DSA certificates are specified by the same server) or different SSL
  44 structures with the same parent SSL_CTX cannot be specified using this
  45 function. For more flexibility functions such as SSL_add1_chain_cert() should
  46 be used instead.
  47
  48 =head1 RETURN VALUES
  49
  50 SSL_CTX_add_extra_chain_cert() and SSL_CTX_clear_extra_chain_certs() return
  51 1 on success and 0 for failure. Check out the error stack to find out the
  52 reason for failure.
  53
  54 =head1 SEE ALSO
  55
  56 L<ssl(3)>,
  57 L<SSL_CTX_use_certificate(3)>,
  58 L<SSL_CTX_set_client_cert_cb(3)>,
  59 L<SSL_CTX_load_verify_locations(3)>
  60 L<SSL_CTX_set0_chain(3)>
  61 L<SSL_CTX_set1_chain(3)>
  62 L<SSL_CTX_add0_chain_cert(3)>
  63 L<SSL_CTX_add1_chain_cert(3)>
  64 L<SSL_set0_chain(3)>
  65 L<SSL_set1_chain(3)>
  66 L<SSL_add0_chain_cert(3)>
  67 L<SSL_add1_chain_cert(3)>
  68 L<SSL_CTX_build_cert_chain(3)>
  69 L<SSL_build_cert_chain(3)>
  70
  71 =cut