5
SSL_CTX_set0_chain, SSL_CTX_set1_chain, SSL_CTX_add0_chain_cert,
6
SSL_CTX_add1_chain_cert, SSL_CTX_get0_chain_certs, SSL_CTX_clear_chain_certs,
7
SSL_set0_chain, SSL_set1_chain, SSL_add0_chain_cert, SSL_add1_chain_cert,
8
SSL_get0_chain_certs, SSL_clear_chain_certs, SSL_CTX_build_cert_chain,
9
SSL_build_cert_chain, SSL_CTX_select_current_cert,
10
SSL_select_current_cert, SSL_CTX_set_current_cert, SSL_set_current_cert - extra
11
chain certificate processing
15
#include <openssl/ssl.h>
17
int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *sk);
18
int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *sk);
19
int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
20
int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
21
int SSL_CTX_get0_chain_certs(SSL_CTX *ctx, STACK_OF(X509) **sk);
22
int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
24
int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *sk);
25
int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *sk);
26
int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
27
int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
28
int SSL_get0_chain_certs(SSL *ssl, STACK_OF(X509) **sk);
29
int SSL_clear_chain_certs(SSL *ssl);
31
int SSL_CTX_build_cert_chain(SSL_CTX *ctx, flags);
32
int SSL_build_cert_chain(SSL *ssl, flags);
34
int SSL_CTX_select_current_cert(SSL_CTX *ctx, X509 *x509);
35
int SSL_select_current_cert(SSL *ssl, X509 *x509);
36
int SSL_CTX_set_current_cert(SSL_CTX *ctx, long op);
37
int SSL_set_current_cert(SSL *ssl, long op);
41
SSL_CTX_set0_chain() and SSL_CTX_set1_chain() set the certificate chain
42
associated with the current certificate of B<ctx> to B<sk>.
44
SSL_CTX_add0_chain_cert() and SSL_CTX_add1_chain_cert() append the single
45
certificate B<x509> to the chain associated with the current certificate of
48
SSL_CTX_get0_chain_certs() retrieves the chain associated with the current
49
certificate of B<ctx>.
51
SSL_CTX_clear_chain_certs() clears any existing chain associated with the
52
current certificate of B<ctx>. (This is implemented by calling
53
SSL_CTX_set0_chain() with B<sk> set to B<NULL>).
55
SSL_CTX_build_cert_chain() builds the certificate chain for B<ctx> normally
56
this uses the chain store or the verify store if the chain store is not set.
57
If the function is successful the built chain will replace any existing chain.
58
The B<flags> parameter can be set to B<SSL_BUILD_CHAIN_FLAG_UNTRUSTED> to use
59
existing chain certificates as untrusted CAs, B<SSL_BUILD_CHAIN_FLAG_NO_ROOT>
60
to omit the root CA from the built chain, B<SSL_BUILD_CHAIN_FLAG_CHECK> to
61
use all existing chain certificates only to build the chain (effectively
62
sanity checking and rearranging them if necessary), the flag
63
B<SSL_BUILD_CHAIN_FLAG_IGNORE_ERROR> ignores any errors during verification:
64
if flag B<SSL_BUILD_CHAIN_FLAG_CLEAR_ERROR> is also set verification errors
65
are cleared from the error queue.
67
Each of these functions operates on the I<current> end entity
68
(i.e. server or client) certificate. This is the last certificate loaded or
69
selected on the corresponding B<ctx> structure.
71
SSL_CTX_select_current_cert() selects B<x509> as the current end entity
72
certificate, but only if B<x509> has already been loaded into B<ctx> using a
73
function such as SSL_CTX_use_certificate().
75
SSL_set0_chain(), SSL_set1_chain(), SSL_add0_chain_cert(),
76
SSL_add1_chain_cert(), SSL_get0_chain_certs(), SSL_clear_chain_certs(),
77
SSL_build_cert_chain(), SSL_select_current_cert() and SSL_set_current_cert()
78
are similar except they apply to SSL structure B<ssl>.
80
SSL_CTX_set_current_cert() changes the current certificate to a value based
81
on the B<op> argument. Currently B<op> can be B<SSL_CERT_SET_FIRST> to use
82
the first valid certificate or B<SSL_CERT_SET_NEXT> to set the next valid
83
certificate after the current certificate. These two operations can be
84
used to iterate over all certificates in an B<SSL_CTX> structure.
86
SSL_set_current_cert() also supports the option B<SSL_CERT_SET_SERVER>.
87
If B<ssl> is a server and has sent a certificate to a connected client
88
this option sets that certificate to the current certificate and returns 1.
89
If the negotiated ciphersuite is anonymous (and thus no certificate will
90
be sent) 2 is returned and the current certificate is unchanged. If B<ssl>
91
is not a server or a certificate has not been sent 0 is returned and
92
the current certificate is unchanged.
94
All these functions are implemented as macros. Those containing a B<1>
95
increment the reference count of the supplied certificate or chain so it must
96
be freed at some point after the operation. Those containing a B<0> do
97
not increment reference counts and the supplied certificate or chain
98
B<MUST NOT> be freed after the operation.
102
The chains associate with an SSL_CTX structure are copied to any SSL
103
structures when SSL_new() is called. SSL structures will not be affected
104
by any chains subsequently changed in the parent SSL_CTX.
106
One chain can be set for each key type supported by a server. So, for example,
107
an RSA and a DSA certificate can (and often will) have different chains.
109
The functions SSL_CTX_build_cert_chain() and SSL_build_cert_chain() can
110
be used to check application configuration and to ensure any necessary
111
subordinate CAs are sent in the correct order. Misconfigured applications
112
sending incorrect certificate chains often cause problems with peers.
114
For example an application can add any set of certificates using
115
SSL_CTX_use_certificate_chain_file() then call SSL_CTX_build_cert_chain()
116
with the option B<SSL_BUILD_CHAIN_FLAG_CHECK> to check and reorder them.
118
Applications can issue non fatal warnings when checking chains by setting
119
the flag B<SSL_BUILD_CHAIN_FLAG_IGNORE_ERRORS> and checking the return
122
Calling SSL_CTX_build_cert_chain() or SSL_build_cert_chain() is more
123
efficient than the automatic chain building as it is only performed once.
124
Automatic chain building is performed on each new session.
126
If any certificates are added using these functions no certificates added
127
using SSL_CTX_add_extra_chain_cert() will be used.
131
SSL_set_current_cert() with B<SSL_CERT_SET_SERVER> return 1 for success, 2 if
132
no server certificate is used because the ciphersuites is anonymous and 0
135
SSL_CTX_build_cert_chain() and SSL_build_cert_chain() return 1 for success
136
and 0 for failure. If the flag B<SSL_BUILD_CHAIN_FLAG_IGNORE_ERROR> and
137
a verification error occurs then 2 is returned.
139
All other functions return 1 for success and 0 for failure.
144
L<SSL_CTX_add_extra_chain_cert(3)|SSL_CTX_add_extra_chain_cert(3)>
148
These functions were first added to OpenSSL 1.0.2.
added
removed
doc/ssl/SSL_CTX_add1_chain_cert.pod
