diff options
author | Sergii Cherkavskyi <[email protected]> | 2019-03-27 17:14:10 +0100 |
---|---|---|
committer | Sergii Cherkavskyi <[email protected]> | 2019-03-27 18:36:38 +0100 |
commit | ff3bd27060f6ffb97b2abba76258d6a450287a5b (patch) | |
tree | 5e02e22e3e6ec652511e8a8d1a7e688484470d51 /doc | |
parent | c6f1c447ce07ee064a6c72c8c7d04ad5b451811d (diff) |
added documentation for acceptable_ciphersuite() and ciphersuite_list()
Diffstat (limited to 'doc')
-rw-r--r-- | doc/manual/tls.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/manual/tls.rst b/doc/manual/tls.rst index c9f404afb..e93631a7c 100644 --- a/doc/manual/tls.rst +++ b/doc/manual/tls.rst @@ -1145,6 +1145,21 @@ TLS Ciphersuites Return the authentication algorithm of this ciphersuite + .. cpp:function:: bool acceptable_ciphersuite(const Ciphersuite& suite) const + + Return true if ciphersuite is accepted by the policy. + + Allows an application to reject any ciphersuites, which are + undesirable for whatever reason without having to reimplement + :cpp:func:`TLS::Ciphersuite::ciphersuite_list` + + .. cpp:function:: std::vector<uint16_t> ciphersuite_list(Protocol_Version version, bool have_srp) const + + Return allowed ciphersuites in order of preference + + Allows an application to have full control over ciphersuites + by returning desired ciphersuites in preference order. + .. _tls_alerts: TLS Alerts |