Clarify docs.
authorJeffrey Walton <noloader@gmail.com>
Fri, 27 Jun 2014 15:33:06 +0000 (16:33 +0100)
committerDr. Stephen Henson <steve@openssl.org>
Fri, 27 Jun 2014 15:44:14 +0000 (16:44 +0100)
Document that the certificate passed to SSL_CTX_add_extra_chain_cert()
should not be freed by the application.

PR#3409

Add restrictions section present in other branches.

(cherry picked from commit 86cac6d3b25342ff17a2b6564f7592fd7c6829e8)

doc/ssl/SSL_CTX_add_extra_chain_cert.pod

index ee28f5ccc3a3e294e8712ab90482bbd7101bdf03..5955ee1cb41535e880ba649af47e6014368055b8 100644 (file)
@@ -24,6 +24,16 @@ the library will try to complete the chain from the available CA
 certificates in the trusted CA storage, see
 L<SSL_CTX_load_verify_locations(3)|SSL_CTX_load_verify_locations(3)>.
 
+The B<x509> certificate provided to SSL_CTX_add_extra_chain_cert() will be freed by the library when the B<SSL_CTX> is destroyed. An application B<should not> free the B<x509> object.
+
+=head1 RESTRICTIONS
+
+Only one set of extra chain certificates can be specified per SSL_CTX
+structure. Different chains for different certificates (for example if both
+RSA and DSA certificates are specified by the same server) or different SSL
+structures with the same parent SSL_CTX cannot be specified using this
+function.
+
 =head1 RETURN VALUES
 
 SSL_CTX_add_extra_chain_cert() returns 1 on success. Check out the