summaryrefslogtreecommitdiffstats
path: root/secure/lib/libssl/man/SSL_CTX_add_extra_chain_cert.3
diff options
context:
space:
mode:
authorjkim <jkim@FreeBSD.org>2015-12-03 21:13:35 +0000
committerjkim <jkim@FreeBSD.org>2015-12-03 21:13:35 +0000
commit8d77ecefb78a0e7ec702cf614a78dd85de9395ee (patch)
treeade84397c16fe1b20cb2a441f603826e49c36cf2 /secure/lib/libssl/man/SSL_CTX_add_extra_chain_cert.3
parent5374819b03f4e6dcb332bf2729f9270e5d10b83a (diff)
parentafd52a5fc90e70242dbb0e7d29987c976eb993e0 (diff)
downloadFreeBSD-src-8d77ecefb78a0e7ec702cf614a78dd85de9395ee.zip
FreeBSD-src-8d77ecefb78a0e7ec702cf614a78dd85de9395ee.tar.gz
Merge OpenSSL 1.0.2e.
Diffstat (limited to 'secure/lib/libssl/man/SSL_CTX_add_extra_chain_cert.3')
-rw-r--r--secure/lib/libssl/man/SSL_CTX_add_extra_chain_cert.339
1 files changed, 25 insertions, 14 deletions
diff --git a/secure/lib/libssl/man/SSL_CTX_add_extra_chain_cert.3 b/secure/lib/libssl/man/SSL_CTX_add_extra_chain_cert.3
index fcaf811..e354223 100644
--- a/secure/lib/libssl/man/SSL_CTX_add_extra_chain_cert.3
+++ b/secure/lib/libssl/man/SSL_CTX_add_extra_chain_cert.3
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.30)
+.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -133,34 +133,44 @@
.\" ========================================================================
.\"
.IX Title "SSL_CTX_add_extra_chain_cert 3"
-.TH SSL_CTX_add_extra_chain_cert 3 "2015-07-09" "1.0.2d" "OpenSSL"
+.TH SSL_CTX_add_extra_chain_cert 3 "2015-12-03" "1.0.2e" "OpenSSL"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
-SSL_CTX_add_extra_chain_cert \- add certificate to chain
+SSL_CTX_add_extra_chain_cert, SSL_CTX_clear_extra_chain_certs \- add or clear
+extra chain certificates
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #include <openssl/ssl.h>
\&
-\& long SSL_CTX_add_extra_chain_cert(SSL_CTX ctx, X509 *x509)
+\& long SSL_CTX_add_extra_chain_cert(SSL_CTX *ctx, X509 *x509);
+\& long SSL_CTX_clear_extra_chain_certs(SSL_CTX *ctx);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
-\&\fISSL_CTX_add_extra_chain_cert()\fR adds the certificate \fBx509\fR to the certificate
-chain presented together with the certificate. Several certificates
-can be added one after the other.
+\&\fISSL_CTX_add_extra_chain_cert()\fR adds the certificate \fBx509\fR to the extra chain
+certificates associated with \fBctx\fR. Several certificates can be added one
+after another.
+.PP
+\&\fISSL_CTX_clear_extra_chain_certs()\fR clears all extra chain certificates
+associated with \fBctx\fR.
+.PP
+These functions are implemented as macros.
.SH "NOTES"
.IX Header "NOTES"
-When constructing the certificate chain, the chain will be formed from
-these certificates explicitly specified. If no chain is specified,
-the library will try to complete the chain from the available \s-1CA\s0
-certificates in the trusted \s-1CA\s0 storage, see
+When sending a certificate chain, extra chain certificates are sent in order
+following the end entity certificate.
+.PP
+If no chain is specified, the library will try to complete the chain from the
+available \s-1CA\s0 certificates in the trusted \s-1CA\s0 storage, see
\&\fISSL_CTX_load_verify_locations\fR\|(3).
.PP
-The \fBx509\fR certificate provided to \fISSL_CTX_add_extra_chain_cert()\fR will be freed by the library when the \fB\s-1SSL_CTX\s0\fR is destroyed. An application \fBshould not\fR free the \fBx509\fR object.
+The \fBx509\fR certificate provided to \fISSL_CTX_add_extra_chain_cert()\fR will be
+freed by the library when the \fB\s-1SSL_CTX\s0\fR is destroyed. An application
+\&\fBshould not\fR free the \fBx509\fR object.
.SH "RESTRICTIONS"
.IX Header "RESTRICTIONS"
Only one set of extra chain certificates can be specified per \s-1SSL_CTX\s0
@@ -171,8 +181,9 @@ function. For more flexibility functions such as \fISSL_add1_chain_cert()\fR sho
be used instead.
.SH "RETURN VALUES"
.IX Header "RETURN VALUES"
-\&\fISSL_CTX_add_extra_chain_cert()\fR returns 1 on success. Check out the
-error stack to find out the reason for failure otherwise.
+\&\fISSL_CTX_add_extra_chain_cert()\fR and \fISSL_CTX_clear_extra_chain_certs()\fR return
+1 on success and 0 for failure. Check out the error stack to find out the
+reason for failure.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIssl\fR\|(3),
OpenPOWER on IntegriCloud