From 5b7cb0d19d7ffe97712c39aaf2f861a2504442aa Mon Sep 17 00:00:00 2001 From: Jack Lloyd Date: Wed, 28 Mar 2018 03:25:59 -0400 Subject: Update TLS docs re new APIs for 2.5 [ci skip] --- doc/manual/credentials_manager.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) (limited to 'doc/manual/credentials_manager.rst') diff --git a/doc/manual/credentials_manager.rst b/doc/manual/credentials_manager.rst index e694f7efd..169e5ab8e 100644 --- a/doc/manual/credentials_manager.rst +++ b/doc/manual/credentials_manager.rst @@ -29,12 +29,23 @@ implementation. The default implementation returns an empty list. + .. cpp:function:: std::vector find_cert_chain( \ + const std::vector& cert_key_types, \ + const std::vector& acceptable_CAs, \ + const std::string& type, \ + const std::string& context) + + Return the certificate chain to use to identify ourselves. The + ``acceptable_CAs`` parameter gives a list of CAs the peer trusts. + This may be empty. + .. cpp:function:: std::vector cert_chain( \ const std::vector& cert_key_types, \ const std::string& type, \ const std::string& context) - Return the certificate chain to use to identify ourselves + Return the certificate chain to use to identify ourselves. Starting in + 2.5, prefer ``find_cert_chain`` which additionally provides the CA list. .. cpp:function:: std::vector cert_chain_single_type( \ const std::string& cert_key_type, \ -- cgit v1.2.3