SSL_CTX_add1_chain_cert.pod 6.8 KB
Newer Older
D
Dr. Stephen Henson 已提交
1 2 3 4 5
=pod

=head1 NAME

SSL_CTX_set0_chain, SSL_CTX_set1_chain, SSL_CTX_add0_chain_cert,
R
Rob Stradling 已提交
6 7 8 9
SSL_CTX_add1_chain_cert, SSL_CTX_get0_chain_certs, SSL_CTX_clear_chain_certs,
SSL_set0_chain, SSL_set1_chain, SSL_add0_chain_cert, SSL_add1_chain_cert,
SSL_get0_chain_certs, SSL_clear_chain_certs, SSL_CTX_build_cert_chain,
SSL_build_cert_chain, SSL_CTX_select_current_cert,
10 11
SSL_select_current_cert, SSL_CTX_set_current_cert, SSL_set_current_cert - extra
chain certificate processing
D
Dr. Stephen Henson 已提交
12 13 14 15 16 17 18

=head1 SYNOPSIS

 #include <openssl/ssl.h>

 int SSL_CTX_set0_chain(SSL_CTX *ctx, STACK_OF(X509) *sk);
 int SSL_CTX_set1_chain(SSL_CTX *ctx, STACK_OF(X509) *sk);
R
Rob Stradling 已提交
19
 int SSL_CTX_add0_chain_cert(SSL_CTX *ctx, X509 *x509);
D
Dr. Stephen Henson 已提交
20
 int SSL_CTX_add1_chain_cert(SSL_CTX *ctx, X509 *x509);
R
Rob Stradling 已提交
21 22
 int SSL_CTX_get0_chain_certs(SSL_CTX *ctx, STACK_OF(X509) **sk);
 int SSL_CTX_clear_chain_certs(SSL_CTX *ctx);
D
Dr. Stephen Henson 已提交
23 24 25

 int SSL_set0_chain(SSL *ssl, STACK_OF(X509) *sk);
 int SSL_set1_chain(SSL *ssl, STACK_OF(X509) *sk);
R
Rob Stradling 已提交
26
 int SSL_add0_chain_cert(SSL *ssl, X509 *x509);
D
Dr. Stephen Henson 已提交
27
 int SSL_add1_chain_cert(SSL *ssl, X509 *x509);
R
Rob Stradling 已提交
28 29
 int SSL_get0_chain_certs(SSL *ssl, STACK_OF(X509) **sk);
 int SSL_clear_chain_certs(SSL *ssl);
D
Dr. Stephen Henson 已提交
30 31

 int SSL_CTX_build_cert_chain(SSL_CTX *ctx, flags);
R
Rob Stradling 已提交
32 33 34 35
 int SSL_build_cert_chain(SSL *ssl, flags);

 int SSL_CTX_select_current_cert(SSL_CTX *ctx, X509 *x509);
 int SSL_select_current_cert(SSL *ssl, X509 *x509);
36 37
 int SSL_CTX_set_current_cert(SSL_CTX *ctx, long op);
 int SSL_set_current_cert(SSL *ssl, long op);
D
Dr. Stephen Henson 已提交
38 39 40 41

=head1 DESCRIPTION

SSL_CTX_set0_chain() and SSL_CTX_set1_chain() set the certificate chain
R
Rob Stradling 已提交
42
associated with the current certificate of B<ctx> to B<sk>.
D
Dr. Stephen Henson 已提交
43 44 45 46 47

SSL_CTX_add0_chain_cert() and SSL_CTX_add1_chain_cert() append the single
certificate B<x509> to the chain associated with the current certificate of
B<ctx>.

R
Rob Stradling 已提交
48 49 50 51 52 53 54
SSL_CTX_get0_chain_certs() retrieves the chain associated with the current
certificate of B<ctx>.

SSL_CTX_clear_chain_certs() clears any existing chain associated with the
current certificate of B<ctx>.  (This is implemented by calling
SSL_CTX_set0_chain() with B<sk> set to B<NULL>).

D
Dr. Stephen Henson 已提交
55 56
SSL_CTX_build_cert_chain() builds the certificate chain for B<ctx> normally
this uses the chain store or the verify store if the chain store is not set.
D
Dr. Stephen Henson 已提交
57
If the function is successful the built chain will replace any existing chain.
D
Dr. Stephen Henson 已提交
58 59 60 61 62
The B<flags> parameter can be set to B<SSL_BUILD_CHAIN_FLAG_UNTRUSTED> to use
existing chain certificates as untrusted CAs, B<SSL_BUILD_CHAIN_FLAG_NO_ROOT>
to omit the root CA from the built chain, B<SSL_BUILD_CHAIN_FLAG_CHECK> to
use all existing chain certificates only to build the chain (effectively
sanity checking and rearranging them if necessary), the flag
63 64 65
B<SSL_BUILD_CHAIN_FLAG_IGNORE_ERROR> ignores any errors during verification:
if flag B<SSL_BUILD_CHAIN_FLAG_CLEAR_ERROR> is also set verification errors
are cleared from the error queue.
D
Dr. Stephen Henson 已提交
66

R
Rob Stradling 已提交
67 68 69 70 71 72 73 74 75 76
Each of these functions operates on the I<current> end entity
(i.e. server or client) certificate. This is the last certificate loaded or
selected on the corresponding B<ctx> structure.

SSL_CTX_select_current_cert() selects B<x509> as the current end entity
certificate, but only if B<x509> has already been loaded into B<ctx> using a
function such as SSL_CTX_use_certificate().

SSL_set0_chain(), SSL_set1_chain(), SSL_add0_chain_cert(),
SSL_add1_chain_cert(), SSL_get0_chain_certs(), SSL_clear_chain_certs(),
77 78 79 80 81 82 83 84
SSL_build_cert_chain(), SSL_select_current_cert() and SSL_set_current_cert()
are similar except they apply to SSL structure B<ssl>.

SSL_CTX_set_current_cert() changes the current certificate to a value based
on the B<op> argument. Currently B<op> can be B<SSL_CERT_SET_FIRST> to use
the first valid certificate or B<SSL_CERT_SET_NEXT> to set the next valid
certificate after the current certificate. These two operations can be
used to iterate over all certificates in an B<SSL_CTX> structure.
D
Dr. Stephen Henson 已提交
85

86 87 88 89 90 91 92 93
SSL_set_current_cert() also supports the option B<SSL_CERT_SET_SERVER>.
If B<ssl> is a server and has sent a certificate to a connected client
this option sets that certificate to the current certificate and returns 1.
If the negotiated ciphersuite is anonymous (and thus no certificate will
be sent) 2 is returned and the current certificate is unchanged. If B<ssl>
is not a server or a certificate has not been sent 0 is returned and
the current certificate is unchanged.

D
Dr. Stephen Henson 已提交
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
All these functions are implemented as macros. Those containing a B<1>
increment the reference count of the supplied certificate or chain so it must
be freed at some point after the operation. Those containing a B<0> do
not increment reference counts and the supplied certificate or chain
B<MUST NOT> be freed after the operation.

=head1 NOTES

The chains associate with an SSL_CTX structure are copied to any SSL
structures when SSL_new() is called. SSL structures will not be affected
by any chains subsequently changed in the parent SSL_CTX.

One chain can be set for each key type supported by a server. So, for example,
an RSA and a DSA certificate can (and often will) have different chains.

The functions SSL_CTX_build_cert_chain() and SSL_build_cert_chain() can
be used to check application configuration and to ensure any necessary
subordinate CAs are sent in the correct order. Misconfigured applications
sending incorrect certificate chains often cause problems with peers.

D
Dr. Stephen Henson 已提交
114 115 116 117
For example an application can add any set of certificates using
SSL_CTX_use_certificate_chain_file() then call SSL_CTX_build_cert_chain()
with the option B<SSL_BUILD_CHAIN_FLAG_CHECK> to check and reorder them.

118 119 120 121
Applications can issue non fatal warnings when checking chains by setting
the flag B<SSL_BUILD_CHAIN_FLAG_IGNORE_ERRORS> and checking the return
value.

D
Dr. Stephen Henson 已提交
122 123 124 125 126 127 128 129 130
Calling SSL_CTX_build_cert_chain() or SSL_build_cert_chain() is more
efficient than the automatic chain building as it is only performed once.
Automatic chain building is performed on each new session.

If any certificates are added using these functions no certificates added
using SSL_CTX_add_extra_chain_cert() will be used.

=head1 RETURN VALUES

D
Dr. Stephen Henson 已提交
131 132 133 134
SSL_set_current_cert() with B<SSL_CERT_SET_SERVER> return 1 for success, 2 if
no server certificate is used because the ciphersuites is anonymous and 0
for failure.

135 136 137 138
SSL_CTX_build_cert_chain() and SSL_build_cert_chain() return 1 for success
and 0 for failure. If the flag B<SSL_BUILD_CHAIN_FLAG_IGNORE_ERROR> and
a verification error occurs then 2 is returned.

D
Dr. Stephen Henson 已提交
139
All other functions return 1 for success and 0 for failure.
D
Dr. Stephen Henson 已提交
140 141 142

=head1 SEE ALSO

R
Rich Salz 已提交
143
L<SSL_CTX_add_extra_chain_cert(3)>
D
Dr. Stephen Henson 已提交
144 145 146 147 148 149

=head1 HISTORY

These functions were first added to OpenSSL 1.0.2.

=cut
R
Rich Salz 已提交
150 151 152 153 154 155 156 157 158 159 160

=head1 COPYRIGHT

Copyright 2013-2016 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut