diff options
author | Jack Lloyd <[email protected]> | 2018-03-28 03:25:59 -0400 |
---|---|---|
committer | Jack Lloyd <[email protected]> | 2018-03-28 05:13:32 -0400 |
commit | 5b7cb0d19d7ffe97712c39aaf2f861a2504442aa (patch) | |
tree | 6bbddc81b11d2115b61a1ce1dce97c64bd8efcc0 /doc/manual/credentials_manager.rst | |
parent | d829bc5dd0002373ad07a09a07082e859f047901 (diff) |
Update TLS docs re new APIs for 2.5 [ci skip]
Diffstat (limited to 'doc/manual/credentials_manager.rst')
-rw-r--r-- | doc/manual/credentials_manager.rst | 13 |
1 files changed, 12 insertions, 1 deletions
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<X509_Certificate> find_cert_chain( \ + const std::vector<std::string>& cert_key_types, \ + const std::vector<X509_DN>& 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<X509_Certificate> cert_chain( \ const std::vector<std::string>& 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<X509_Certificate> cert_chain_single_type( \ const std::string& cert_key_type, \ |