1=pod
2
3=head1 NAME
4
5SSL_CTX_add_extra_chain_cert,
6SSL_CTX_get_extra_chain_certs,
7SSL_CTX_get_extra_chain_certs_only,
8SSL_CTX_clear_extra_chain_certs
9- add, get or clear extra chain certificates
10
11=head1 SYNOPSIS
12
13 #include <openssl/ssl.h>
14
15 long SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
16 long SSL_CTX_get_extra_chain_certs(SSL_CTX *ctx, STACK_OF(X509) **sk);
17 long SSL_CTX_get_extra_chain_certs_only(SSL_CTX *ctx, STACK_OF(X509) **sk);
18 long SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
19
20=head1 DESCRIPTION
21
22SSL_CTX_add_extra_chain_cert() adds the certificate B<x509> to the extra chain
23certificates associated with B<ctx>. Several certificates can be added one
24after another.
25
26SSL_CTX_get_extra_chain_certs() retrieves the extra chain certificates
27associated with B<ctx>, or the chain associated with the current certificate
28of B<ctx> if the extra chain is empty.
29The returned stack should not be freed by the caller.
30
31SSL_CTX_get_extra_chain_certs_only() retrieves the extra chain certificates
32associated with B<ctx>.
33The returned stack should not be freed by the caller.
34
35SSL_CTX_clear_extra_chain_certs() clears all extra chain certificates
36associated with B<ctx>.
37
38These functions are implemented as macros.
39
40=head1 NOTES
41
42When sending a certificate chain, extra chain certificates are sent in order
43following the end entity certificate.
44
45If no chain is specified, the library will try to complete the chain from the
46available CA certificates in the trusted CA storage, see
47L<SSL_CTX_load_verify_locations(3)>.
48
49The B<x509> certificate provided to SSL_CTX_add_extra_chain_cert() will be
50freed by the library when the B<SSL_CTX> is destroyed. An application
51B<should not> free the B<x509> object.
52
53=head1 RESTRICTIONS
54
55Only one set of extra chain certificates can be specified per SSL_CTX
56structure. Different chains for different certificates (for example if both
57RSA and DSA certificates are specified by the same server) or different SSL
58structures with the same parent SSL_CTX cannot be specified using this
59function. For more flexibility functions such as SSL_add1_chain_cert() should
60be used instead.
61
62=head1 RETURN VALUES
63
64SSL_CTX_add_extra_chain_cert() and SSL_CTX_clear_extra_chain_certs() return
651 on success and 0 for failure. Check out the error stack to find out the
66reason for failure.
67
68=head1 SEE ALSO
69
70L<ssl(7)>,
71L<SSL_CTX_use_certificate(3)>,
72L<SSL_CTX_set_client_cert_cb(3)>,
73L<SSL_CTX_load_verify_locations(3)>
74L<SSL_CTX_set0_chain(3)>
75L<SSL_CTX_set1_chain(3)>
76L<SSL_CTX_add0_chain_cert(3)>
77L<SSL_CTX_add1_chain_cert(3)>
78L<SSL_set0_chain(3)>
79L<SSL_set1_chain(3)>
80L<SSL_add0_chain_cert(3)>
81L<SSL_add1_chain_cert(3)>
82L<SSL_CTX_build_cert_chain(3)>
83L<SSL_build_cert_chain(3)>
84
85=head1 COPYRIGHT
86
87Copyright 2000-2018 The OpenSSL Project Authors. All Rights Reserved.
88
89Licensed under the Apache License 2.0 (the "License").  You may not use
90this file except in compliance with the License.  You can obtain a copy
91in the file LICENSE in the source distribution or at
92L<https://www.openssl.org/source/license.html>.
93
94=cut
95